blob: 6db80635ace81f02d07edc1fc2e6119338de3e6f [file] [log] [blame]
David Brownell8ae12a02006-01-08 13:34:19 -08001/*
Grant Likelyca632f52011-06-06 01:16:30 -06002 * SPI init/core code
David Brownell8ae12a02006-01-08 13:34:19 -08003 *
4 * Copyright (C) 2005 David Brownell
Grant Likelyd57a4282012-04-07 14:16:53 -06005 * Copyright (C) 2008 Secret Lab Technologies Ltd.
David Brownell8ae12a02006-01-08 13:34:19 -08006 *
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.
11 *
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.
David Brownell8ae12a02006-01-08 13:34:19 -080016 */
17
David Brownell8ae12a02006-01-08 13:34:19 -080018#include <linux/kernel.h>
19#include <linux/device.h>
20#include <linux/init.h>
21#include <linux/cache.h>
Mark Brown99adef32014-01-16 12:22:43 +000022#include <linux/dma-mapping.h>
23#include <linux/dmaengine.h>
Matthias Kaehlcke94040822007-07-17 04:04:16 -070024#include <linux/mutex.h>
Sinan Akman2b7a32f2010-10-02 21:28:29 -060025#include <linux/of_device.h>
Grant Likelyd57a4282012-04-07 14:16:53 -060026#include <linux/of_irq.h>
Sylwester Nawrocki86be4082014-06-18 17:29:32 +020027#include <linux/clk/clk-conf.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090028#include <linux/slab.h>
Anton Vorontsove0626e32009-09-22 16:46:08 -070029#include <linux/mod_devicetable.h>
David Brownell8ae12a02006-01-08 13:34:19 -080030#include <linux/spi/spi.h>
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +010031#include <linux/of_gpio.h>
Mark Brown3ae22e82010-12-25 15:32:27 +010032#include <linux/pm_runtime.h>
Ulf Hanssonf48c7672014-09-29 13:58:47 +020033#include <linux/pm_domain.h>
Paul Gortmaker025ed132011-07-10 12:57:55 -040034#include <linux/export.h>
Clark Williams8bd75c72013-02-07 09:47:07 -060035#include <linux/sched/rt.h>
Linus Walleijffbbdd212012-02-22 10:05:38 +010036#include <linux/delay.h>
37#include <linux/kthread.h>
Mika Westerberg64bee4d2012-11-30 12:37:53 +010038#include <linux/ioport.h>
39#include <linux/acpi.h>
Vignesh Rb1b81532016-08-17 15:22:36 +053040#include <linux/highmem.h>
David Brownell8ae12a02006-01-08 13:34:19 -080041
Mark Brown56ec1972013-10-07 19:33:53 +010042#define CREATE_TRACE_POINTS
43#include <trace/events/spi.h>
44
David Brownell8ae12a02006-01-08 13:34:19 -080045static void spidev_release(struct device *dev)
46{
Hans-Peter Nilsson0ffa0282007-02-12 00:52:45 -080047 struct spi_device *spi = to_spi_device(dev);
David Brownell8ae12a02006-01-08 13:34:19 -080048
49 /* spi masters may cleanup for released devices */
50 if (spi->master->cleanup)
51 spi->master->cleanup(spi);
52
David Brownell0c868462006-01-08 13:34:25 -080053 spi_master_put(spi->master);
Roman Tereshonkov07a389f2010-04-12 09:56:35 +000054 kfree(spi);
David Brownell8ae12a02006-01-08 13:34:19 -080055}
56
57static ssize_t
58modalias_show(struct device *dev, struct device_attribute *a, char *buf)
59{
60 const struct spi_device *spi = to_spi_device(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +080061 int len;
62
63 len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
64 if (len != -ENODEV)
65 return len;
David Brownell8ae12a02006-01-08 13:34:19 -080066
Grant Likelyd8e328b2012-05-20 00:08:13 -060067 return sprintf(buf, "%s%s\n", SPI_MODULE_PREFIX, spi->modalias);
David Brownell8ae12a02006-01-08 13:34:19 -080068}
Greg Kroah-Hartmanaa7da562013-10-07 18:27:38 -070069static DEVICE_ATTR_RO(modalias);
David Brownell8ae12a02006-01-08 13:34:19 -080070
Martin Sperleca2ebc2015-06-22 13:00:36 +000071#define SPI_STATISTICS_ATTRS(field, file) \
72static ssize_t spi_master_##field##_show(struct device *dev, \
73 struct device_attribute *attr, \
74 char *buf) \
75{ \
76 struct spi_master *master = container_of(dev, \
77 struct spi_master, dev); \
78 return spi_statistics_##field##_show(&master->statistics, buf); \
79} \
80static struct device_attribute dev_attr_spi_master_##field = { \
81 .attr = { .name = file, .mode = S_IRUGO }, \
82 .show = spi_master_##field##_show, \
83}; \
84static ssize_t spi_device_##field##_show(struct device *dev, \
85 struct device_attribute *attr, \
86 char *buf) \
87{ \
Geliang Tangd1eba932015-12-23 00:18:41 +080088 struct spi_device *spi = to_spi_device(dev); \
Martin Sperleca2ebc2015-06-22 13:00:36 +000089 return spi_statistics_##field##_show(&spi->statistics, buf); \
90} \
91static struct device_attribute dev_attr_spi_device_##field = { \
92 .attr = { .name = file, .mode = S_IRUGO }, \
93 .show = spi_device_##field##_show, \
94}
95
96#define SPI_STATISTICS_SHOW_NAME(name, file, field, format_string) \
97static ssize_t spi_statistics_##name##_show(struct spi_statistics *stat, \
98 char *buf) \
99{ \
100 unsigned long flags; \
101 ssize_t len; \
102 spin_lock_irqsave(&stat->lock, flags); \
103 len = sprintf(buf, format_string, stat->field); \
104 spin_unlock_irqrestore(&stat->lock, flags); \
105 return len; \
106} \
107SPI_STATISTICS_ATTRS(name, file)
108
109#define SPI_STATISTICS_SHOW(field, format_string) \
110 SPI_STATISTICS_SHOW_NAME(field, __stringify(field), \
111 field, format_string)
112
113SPI_STATISTICS_SHOW(messages, "%lu");
114SPI_STATISTICS_SHOW(transfers, "%lu");
115SPI_STATISTICS_SHOW(errors, "%lu");
116SPI_STATISTICS_SHOW(timedout, "%lu");
117
118SPI_STATISTICS_SHOW(spi_sync, "%lu");
119SPI_STATISTICS_SHOW(spi_sync_immediate, "%lu");
120SPI_STATISTICS_SHOW(spi_async, "%lu");
121
122SPI_STATISTICS_SHOW(bytes, "%llu");
123SPI_STATISTICS_SHOW(bytes_rx, "%llu");
124SPI_STATISTICS_SHOW(bytes_tx, "%llu");
125
Martin Sperl6b7bc062015-06-22 13:02:04 +0000126#define SPI_STATISTICS_TRANSFER_BYTES_HISTO(index, number) \
127 SPI_STATISTICS_SHOW_NAME(transfer_bytes_histo##index, \
128 "transfer_bytes_histo_" number, \
129 transfer_bytes_histo[index], "%lu")
130SPI_STATISTICS_TRANSFER_BYTES_HISTO(0, "0-1");
131SPI_STATISTICS_TRANSFER_BYTES_HISTO(1, "2-3");
132SPI_STATISTICS_TRANSFER_BYTES_HISTO(2, "4-7");
133SPI_STATISTICS_TRANSFER_BYTES_HISTO(3, "8-15");
134SPI_STATISTICS_TRANSFER_BYTES_HISTO(4, "16-31");
135SPI_STATISTICS_TRANSFER_BYTES_HISTO(5, "32-63");
136SPI_STATISTICS_TRANSFER_BYTES_HISTO(6, "64-127");
137SPI_STATISTICS_TRANSFER_BYTES_HISTO(7, "128-255");
138SPI_STATISTICS_TRANSFER_BYTES_HISTO(8, "256-511");
139SPI_STATISTICS_TRANSFER_BYTES_HISTO(9, "512-1023");
140SPI_STATISTICS_TRANSFER_BYTES_HISTO(10, "1024-2047");
141SPI_STATISTICS_TRANSFER_BYTES_HISTO(11, "2048-4095");
142SPI_STATISTICS_TRANSFER_BYTES_HISTO(12, "4096-8191");
143SPI_STATISTICS_TRANSFER_BYTES_HISTO(13, "8192-16383");
144SPI_STATISTICS_TRANSFER_BYTES_HISTO(14, "16384-32767");
145SPI_STATISTICS_TRANSFER_BYTES_HISTO(15, "32768-65535");
146SPI_STATISTICS_TRANSFER_BYTES_HISTO(16, "65536+");
147
Martin Sperld9f12122015-12-14 15:20:20 +0000148SPI_STATISTICS_SHOW(transfers_split_maxsize, "%lu");
149
Greg Kroah-Hartmanaa7da562013-10-07 18:27:38 -0700150static struct attribute *spi_dev_attrs[] = {
151 &dev_attr_modalias.attr,
152 NULL,
David Brownell8ae12a02006-01-08 13:34:19 -0800153};
Martin Sperleca2ebc2015-06-22 13:00:36 +0000154
155static const struct attribute_group spi_dev_group = {
156 .attrs = spi_dev_attrs,
157};
158
159static struct attribute *spi_device_statistics_attrs[] = {
160 &dev_attr_spi_device_messages.attr,
161 &dev_attr_spi_device_transfers.attr,
162 &dev_attr_spi_device_errors.attr,
163 &dev_attr_spi_device_timedout.attr,
164 &dev_attr_spi_device_spi_sync.attr,
165 &dev_attr_spi_device_spi_sync_immediate.attr,
166 &dev_attr_spi_device_spi_async.attr,
167 &dev_attr_spi_device_bytes.attr,
168 &dev_attr_spi_device_bytes_rx.attr,
169 &dev_attr_spi_device_bytes_tx.attr,
Martin Sperl6b7bc062015-06-22 13:02:04 +0000170 &dev_attr_spi_device_transfer_bytes_histo0.attr,
171 &dev_attr_spi_device_transfer_bytes_histo1.attr,
172 &dev_attr_spi_device_transfer_bytes_histo2.attr,
173 &dev_attr_spi_device_transfer_bytes_histo3.attr,
174 &dev_attr_spi_device_transfer_bytes_histo4.attr,
175 &dev_attr_spi_device_transfer_bytes_histo5.attr,
176 &dev_attr_spi_device_transfer_bytes_histo6.attr,
177 &dev_attr_spi_device_transfer_bytes_histo7.attr,
178 &dev_attr_spi_device_transfer_bytes_histo8.attr,
179 &dev_attr_spi_device_transfer_bytes_histo9.attr,
180 &dev_attr_spi_device_transfer_bytes_histo10.attr,
181 &dev_attr_spi_device_transfer_bytes_histo11.attr,
182 &dev_attr_spi_device_transfer_bytes_histo12.attr,
183 &dev_attr_spi_device_transfer_bytes_histo13.attr,
184 &dev_attr_spi_device_transfer_bytes_histo14.attr,
185 &dev_attr_spi_device_transfer_bytes_histo15.attr,
186 &dev_attr_spi_device_transfer_bytes_histo16.attr,
Martin Sperld9f12122015-12-14 15:20:20 +0000187 &dev_attr_spi_device_transfers_split_maxsize.attr,
Martin Sperleca2ebc2015-06-22 13:00:36 +0000188 NULL,
189};
190
191static const struct attribute_group spi_device_statistics_group = {
192 .name = "statistics",
193 .attrs = spi_device_statistics_attrs,
194};
195
196static const struct attribute_group *spi_dev_groups[] = {
197 &spi_dev_group,
198 &spi_device_statistics_group,
199 NULL,
200};
201
202static struct attribute *spi_master_statistics_attrs[] = {
203 &dev_attr_spi_master_messages.attr,
204 &dev_attr_spi_master_transfers.attr,
205 &dev_attr_spi_master_errors.attr,
206 &dev_attr_spi_master_timedout.attr,
207 &dev_attr_spi_master_spi_sync.attr,
208 &dev_attr_spi_master_spi_sync_immediate.attr,
209 &dev_attr_spi_master_spi_async.attr,
210 &dev_attr_spi_master_bytes.attr,
211 &dev_attr_spi_master_bytes_rx.attr,
212 &dev_attr_spi_master_bytes_tx.attr,
Martin Sperl6b7bc062015-06-22 13:02:04 +0000213 &dev_attr_spi_master_transfer_bytes_histo0.attr,
214 &dev_attr_spi_master_transfer_bytes_histo1.attr,
215 &dev_attr_spi_master_transfer_bytes_histo2.attr,
216 &dev_attr_spi_master_transfer_bytes_histo3.attr,
217 &dev_attr_spi_master_transfer_bytes_histo4.attr,
218 &dev_attr_spi_master_transfer_bytes_histo5.attr,
219 &dev_attr_spi_master_transfer_bytes_histo6.attr,
220 &dev_attr_spi_master_transfer_bytes_histo7.attr,
221 &dev_attr_spi_master_transfer_bytes_histo8.attr,
222 &dev_attr_spi_master_transfer_bytes_histo9.attr,
223 &dev_attr_spi_master_transfer_bytes_histo10.attr,
224 &dev_attr_spi_master_transfer_bytes_histo11.attr,
225 &dev_attr_spi_master_transfer_bytes_histo12.attr,
226 &dev_attr_spi_master_transfer_bytes_histo13.attr,
227 &dev_attr_spi_master_transfer_bytes_histo14.attr,
228 &dev_attr_spi_master_transfer_bytes_histo15.attr,
229 &dev_attr_spi_master_transfer_bytes_histo16.attr,
Martin Sperld9f12122015-12-14 15:20:20 +0000230 &dev_attr_spi_master_transfers_split_maxsize.attr,
Martin Sperleca2ebc2015-06-22 13:00:36 +0000231 NULL,
232};
233
234static const struct attribute_group spi_master_statistics_group = {
235 .name = "statistics",
236 .attrs = spi_master_statistics_attrs,
237};
238
239static const struct attribute_group *spi_master_groups[] = {
240 &spi_master_statistics_group,
241 NULL,
242};
243
244void spi_statistics_add_transfer_stats(struct spi_statistics *stats,
245 struct spi_transfer *xfer,
246 struct spi_master *master)
247{
248 unsigned long flags;
Martin Sperl6b7bc062015-06-22 13:02:04 +0000249 int l2len = min(fls(xfer->len), SPI_STATISTICS_HISTO_SIZE) - 1;
250
251 if (l2len < 0)
252 l2len = 0;
Martin Sperleca2ebc2015-06-22 13:00:36 +0000253
254 spin_lock_irqsave(&stats->lock, flags);
255
256 stats->transfers++;
Martin Sperl6b7bc062015-06-22 13:02:04 +0000257 stats->transfer_bytes_histo[l2len]++;
Martin Sperleca2ebc2015-06-22 13:00:36 +0000258
259 stats->bytes += xfer->len;
260 if ((xfer->tx_buf) &&
261 (xfer->tx_buf != master->dummy_tx))
262 stats->bytes_tx += xfer->len;
263 if ((xfer->rx_buf) &&
264 (xfer->rx_buf != master->dummy_rx))
265 stats->bytes_rx += xfer->len;
266
267 spin_unlock_irqrestore(&stats->lock, flags);
268}
269EXPORT_SYMBOL_GPL(spi_statistics_add_transfer_stats);
David Brownell8ae12a02006-01-08 13:34:19 -0800270
271/* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
272 * and the sysfs version makes coldplug work too.
273 */
274
Anton Vorontsov75368bf2009-09-22 16:46:04 -0700275static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
276 const struct spi_device *sdev)
277{
278 while (id->name[0]) {
279 if (!strcmp(sdev->modalias, id->name))
280 return id;
281 id++;
282 }
283 return NULL;
284}
285
286const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
287{
288 const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
289
290 return spi_match_id(sdrv->id_table, sdev);
291}
292EXPORT_SYMBOL_GPL(spi_get_device_id);
293
David Brownell8ae12a02006-01-08 13:34:19 -0800294static int spi_match_device(struct device *dev, struct device_driver *drv)
295{
296 const struct spi_device *spi = to_spi_device(dev);
Anton Vorontsov75368bf2009-09-22 16:46:04 -0700297 const struct spi_driver *sdrv = to_spi_driver(drv);
298
Sinan Akman2b7a32f2010-10-02 21:28:29 -0600299 /* Attempt an OF style match */
300 if (of_driver_match_device(dev, drv))
301 return 1;
302
Mika Westerberg64bee4d2012-11-30 12:37:53 +0100303 /* Then try ACPI */
304 if (acpi_driver_match_device(dev, drv))
305 return 1;
306
Anton Vorontsov75368bf2009-09-22 16:46:04 -0700307 if (sdrv->id_table)
308 return !!spi_match_id(sdrv->id_table, spi);
David Brownell8ae12a02006-01-08 13:34:19 -0800309
Kay Sievers35f74fc2009-01-06 10:44:37 -0800310 return strcmp(spi->modalias, drv->name) == 0;
David Brownell8ae12a02006-01-08 13:34:19 -0800311}
312
Kay Sievers7eff2e72007-08-14 15:15:12 +0200313static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell8ae12a02006-01-08 13:34:19 -0800314{
315 const struct spi_device *spi = to_spi_device(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800316 int rc;
317
318 rc = acpi_device_uevent_modalias(dev, env);
319 if (rc != -ENODEV)
320 return rc;
David Brownell8ae12a02006-01-08 13:34:19 -0800321
Anton Vorontsove0626e32009-09-22 16:46:08 -0700322 add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
David Brownell8ae12a02006-01-08 13:34:19 -0800323 return 0;
324}
325
David Brownell8ae12a02006-01-08 13:34:19 -0800326struct bus_type spi_bus_type = {
327 .name = "spi",
Greg Kroah-Hartmanaa7da562013-10-07 18:27:38 -0700328 .dev_groups = spi_dev_groups,
David Brownell8ae12a02006-01-08 13:34:19 -0800329 .match = spi_match_device,
330 .uevent = spi_uevent,
David Brownell8ae12a02006-01-08 13:34:19 -0800331};
332EXPORT_SYMBOL_GPL(spi_bus_type);
333
David Brownellb8852442006-01-08 13:34:23 -0800334
335static int spi_drv_probe(struct device *dev)
336{
337 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
Jon Hunter44af7922015-10-09 15:45:55 +0100338 struct spi_device *spi = to_spi_device(dev);
Mika Westerberg33cf00e2013-10-10 13:28:48 +0300339 int ret;
David Brownellb8852442006-01-08 13:34:23 -0800340
Sylwester Nawrocki86be4082014-06-18 17:29:32 +0200341 ret = of_clk_set_defaults(dev->of_node, false);
342 if (ret)
343 return ret;
344
Jon Hunter44af7922015-10-09 15:45:55 +0100345 if (dev->of_node) {
346 spi->irq = of_irq_get(dev->of_node, 0);
347 if (spi->irq == -EPROBE_DEFER)
348 return -EPROBE_DEFER;
349 if (spi->irq < 0)
350 spi->irq = 0;
351 }
352
Ulf Hansson676e7c22014-09-19 20:27:41 +0200353 ret = dev_pm_domain_attach(dev, true);
354 if (ret != -EPROBE_DEFER) {
Jon Hunter44af7922015-10-09 15:45:55 +0100355 ret = sdrv->probe(spi);
Ulf Hansson676e7c22014-09-19 20:27:41 +0200356 if (ret)
357 dev_pm_domain_detach(dev, true);
358 }
Mika Westerberg33cf00e2013-10-10 13:28:48 +0300359
360 return ret;
David Brownellb8852442006-01-08 13:34:23 -0800361}
362
363static int spi_drv_remove(struct device *dev)
364{
365 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
Mika Westerberg33cf00e2013-10-10 13:28:48 +0300366 int ret;
David Brownellb8852442006-01-08 13:34:23 -0800367
Jean Delvareaec35f42014-02-13 15:28:41 +0100368 ret = sdrv->remove(to_spi_device(dev));
Ulf Hansson676e7c22014-09-19 20:27:41 +0200369 dev_pm_domain_detach(dev, true);
Mika Westerberg33cf00e2013-10-10 13:28:48 +0300370
371 return ret;
David Brownellb8852442006-01-08 13:34:23 -0800372}
373
374static void spi_drv_shutdown(struct device *dev)
375{
376 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
377
378 sdrv->shutdown(to_spi_device(dev));
379}
380
David Brownell33e34dc2007-05-08 00:32:21 -0700381/**
Andrew F. Davisca5d2482015-10-23 08:59:10 -0500382 * __spi_register_driver - register a SPI driver
Thierry Reding88c93212015-11-10 13:03:04 +0100383 * @owner: owner module of the driver to register
David Brownell33e34dc2007-05-08 00:32:21 -0700384 * @sdrv: the driver to register
385 * Context: can sleep
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200386 *
387 * Return: zero on success, else a negative error code.
David Brownell33e34dc2007-05-08 00:32:21 -0700388 */
Andrew F. Davisca5d2482015-10-23 08:59:10 -0500389int __spi_register_driver(struct module *owner, struct spi_driver *sdrv)
David Brownellb8852442006-01-08 13:34:23 -0800390{
Andrew F. Davisca5d2482015-10-23 08:59:10 -0500391 sdrv->driver.owner = owner;
David Brownellb8852442006-01-08 13:34:23 -0800392 sdrv->driver.bus = &spi_bus_type;
393 if (sdrv->probe)
394 sdrv->driver.probe = spi_drv_probe;
395 if (sdrv->remove)
396 sdrv->driver.remove = spi_drv_remove;
397 if (sdrv->shutdown)
398 sdrv->driver.shutdown = spi_drv_shutdown;
399 return driver_register(&sdrv->driver);
400}
Andrew F. Davisca5d2482015-10-23 08:59:10 -0500401EXPORT_SYMBOL_GPL(__spi_register_driver);
David Brownellb8852442006-01-08 13:34:23 -0800402
David Brownell8ae12a02006-01-08 13:34:19 -0800403/*-------------------------------------------------------------------------*/
404
405/* SPI devices should normally not be created by SPI device drivers; that
406 * would make them board-specific. Similarly with SPI master drivers.
407 * Device registration normally goes into like arch/.../mach.../board-YYY.c
408 * with other readonly (flashable) information about mainboard devices.
409 */
410
411struct boardinfo {
412 struct list_head list;
Feng Tang2b9603a2010-08-02 15:52:15 +0800413 struct spi_board_info board_info;
David Brownell8ae12a02006-01-08 13:34:19 -0800414};
415
416static LIST_HEAD(board_list);
Feng Tang2b9603a2010-08-02 15:52:15 +0800417static LIST_HEAD(spi_master_list);
418
419/*
420 * Used to protect add/del opertion for board_info list and
421 * spi_master list, and their matching process
422 */
Matthias Kaehlcke94040822007-07-17 04:04:16 -0700423static DEFINE_MUTEX(board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800424
Grant Likelydc87c982008-05-15 16:50:22 -0600425/**
426 * spi_alloc_device - Allocate a new SPI device
427 * @master: Controller to which device is connected
428 * Context: can sleep
429 *
430 * Allows a driver to allocate and initialize a spi_device without
431 * registering it immediately. This allows a driver to directly
432 * fill the spi_device with device parameters before calling
433 * spi_add_device() on it.
434 *
435 * Caller is responsible to call spi_add_device() on the returned
436 * spi_device structure to add it to the SPI master. If the caller
437 * needs to discard the spi_device without adding it, then it should
438 * call spi_dev_put() on it.
439 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200440 * Return: a pointer to the new device, or NULL.
Grant Likelydc87c982008-05-15 16:50:22 -0600441 */
442struct spi_device *spi_alloc_device(struct spi_master *master)
443{
444 struct spi_device *spi;
Grant Likelydc87c982008-05-15 16:50:22 -0600445
446 if (!spi_master_get(master))
447 return NULL;
448
Jingoo Han5fe5f052013-10-14 10:31:51 +0900449 spi = kzalloc(sizeof(*spi), GFP_KERNEL);
Grant Likelydc87c982008-05-15 16:50:22 -0600450 if (!spi) {
Grant Likelydc87c982008-05-15 16:50:22 -0600451 spi_master_put(master);
452 return NULL;
453 }
454
455 spi->master = master;
Laurent Pinchart178db7d2011-12-12 01:15:06 +0100456 spi->dev.parent = &master->dev;
Grant Likelydc87c982008-05-15 16:50:22 -0600457 spi->dev.bus = &spi_bus_type;
458 spi->dev.release = spidev_release;
Andreas Larsson446411e2013-02-13 14:20:25 +0100459 spi->cs_gpio = -ENOENT;
Martin Sperleca2ebc2015-06-22 13:00:36 +0000460
461 spin_lock_init(&spi->statistics.lock);
462
Grant Likelydc87c982008-05-15 16:50:22 -0600463 device_initialize(&spi->dev);
464 return spi;
465}
466EXPORT_SYMBOL_GPL(spi_alloc_device);
467
Jarkko Nikulae13ac472013-11-14 14:03:53 +0200468static void spi_dev_set_name(struct spi_device *spi)
469{
470 struct acpi_device *adev = ACPI_COMPANION(&spi->dev);
471
472 if (adev) {
473 dev_set_name(&spi->dev, "spi-%s", acpi_dev_name(adev));
474 return;
475 }
476
477 dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
478 spi->chip_select);
479}
480
Mika Westerbergb6fb8d32014-01-09 15:23:55 +0200481static int spi_dev_check(struct device *dev, void *data)
482{
483 struct spi_device *spi = to_spi_device(dev);
484 struct spi_device *new_spi = data;
485
486 if (spi->master == new_spi->master &&
487 spi->chip_select == new_spi->chip_select)
488 return -EBUSY;
489 return 0;
490}
491
Grant Likelydc87c982008-05-15 16:50:22 -0600492/**
493 * spi_add_device - Add spi_device allocated with spi_alloc_device
494 * @spi: spi_device to register
495 *
496 * Companion function to spi_alloc_device. Devices allocated with
497 * spi_alloc_device can be added onto the spi bus with this function.
498 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200499 * Return: 0 on success; negative errno on failure
Grant Likelydc87c982008-05-15 16:50:22 -0600500 */
501int spi_add_device(struct spi_device *spi)
502{
David Brownelle48880e2008-08-15 00:40:44 -0700503 static DEFINE_MUTEX(spi_add_lock);
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100504 struct spi_master *master = spi->master;
505 struct device *dev = master->dev.parent;
Grant Likelydc87c982008-05-15 16:50:22 -0600506 int status;
507
508 /* Chipselects are numbered 0..max; validate. */
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100509 if (spi->chip_select >= master->num_chipselect) {
Grant Likelydc87c982008-05-15 16:50:22 -0600510 dev_err(dev, "cs%d >= max %d\n",
511 spi->chip_select,
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100512 master->num_chipselect);
Grant Likelydc87c982008-05-15 16:50:22 -0600513 return -EINVAL;
514 }
515
516 /* Set the bus ID string */
Jarkko Nikulae13ac472013-11-14 14:03:53 +0200517 spi_dev_set_name(spi);
David Brownelle48880e2008-08-15 00:40:44 -0700518
519 /* We need to make sure there's no other device with this
520 * chipselect **BEFORE** we call setup(), else we'll trash
521 * its configuration. Lock against concurrent add() calls.
522 */
523 mutex_lock(&spi_add_lock);
524
Mika Westerbergb6fb8d32014-01-09 15:23:55 +0200525 status = bus_for_each_dev(&spi_bus_type, NULL, spi, spi_dev_check);
526 if (status) {
David Brownelle48880e2008-08-15 00:40:44 -0700527 dev_err(dev, "chipselect %d already in use\n",
528 spi->chip_select);
David Brownelle48880e2008-08-15 00:40:44 -0700529 goto done;
530 }
531
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100532 if (master->cs_gpios)
533 spi->cs_gpio = master->cs_gpios[spi->chip_select];
534
David Brownelle48880e2008-08-15 00:40:44 -0700535 /* Drivers may modify this initial i/o setup, but will
536 * normally rely on the device being setup. Devices
537 * using SPI_CS_HIGH can't coexist well otherwise...
538 */
David Brownell7d077192009-06-17 16:26:03 -0700539 status = spi_setup(spi);
Grant Likelydc87c982008-05-15 16:50:22 -0600540 if (status < 0) {
Linus Walleijeb288a12010-10-21 21:06:44 +0200541 dev_err(dev, "can't setup %s, status %d\n",
542 dev_name(&spi->dev), status);
David Brownelle48880e2008-08-15 00:40:44 -0700543 goto done;
Grant Likelydc87c982008-05-15 16:50:22 -0600544 }
545
David Brownelle48880e2008-08-15 00:40:44 -0700546 /* Device may be bound to an active driver when this returns */
Grant Likelydc87c982008-05-15 16:50:22 -0600547 status = device_add(&spi->dev);
David Brownelle48880e2008-08-15 00:40:44 -0700548 if (status < 0)
Linus Walleijeb288a12010-10-21 21:06:44 +0200549 dev_err(dev, "can't add %s, status %d\n",
550 dev_name(&spi->dev), status);
David Brownelle48880e2008-08-15 00:40:44 -0700551 else
Kay Sievers35f74fc2009-01-06 10:44:37 -0800552 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
Grant Likelydc87c982008-05-15 16:50:22 -0600553
David Brownelle48880e2008-08-15 00:40:44 -0700554done:
555 mutex_unlock(&spi_add_lock);
556 return status;
Grant Likelydc87c982008-05-15 16:50:22 -0600557}
558EXPORT_SYMBOL_GPL(spi_add_device);
David Brownell8ae12a02006-01-08 13:34:19 -0800559
David Brownell33e34dc2007-05-08 00:32:21 -0700560/**
561 * spi_new_device - instantiate one new SPI device
562 * @master: Controller to which device is connected
563 * @chip: Describes the SPI device
564 * Context: can sleep
565 *
566 * On typical mainboards, this is purely internal; and it's not needed
David Brownell8ae12a02006-01-08 13:34:19 -0800567 * after board init creates the hard-wired devices. Some development
568 * platforms may not be able to use spi_register_board_info though, and
569 * this is exported so that for example a USB or parport based adapter
570 * driver could add devices (which it would learn about out-of-band).
David Brownell082c8cb2007-07-31 00:39:45 -0700571 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200572 * Return: the new device, or NULL.
David Brownell8ae12a02006-01-08 13:34:19 -0800573 */
Adrian Bunke9d5a462007-03-26 21:32:23 -0800574struct spi_device *spi_new_device(struct spi_master *master,
575 struct spi_board_info *chip)
David Brownell8ae12a02006-01-08 13:34:19 -0800576{
577 struct spi_device *proxy;
David Brownell8ae12a02006-01-08 13:34:19 -0800578 int status;
579
David Brownell082c8cb2007-07-31 00:39:45 -0700580 /* NOTE: caller did any chip->bus_num checks necessary.
581 *
582 * Also, unless we change the return value convention to use
583 * error-or-pointer (not NULL-or-pointer), troubleshootability
584 * suggests syslogged diagnostics are best here (ugh).
585 */
586
Grant Likelydc87c982008-05-15 16:50:22 -0600587 proxy = spi_alloc_device(master);
588 if (!proxy)
David Brownell8ae12a02006-01-08 13:34:19 -0800589 return NULL;
590
Grant Likely102eb972008-07-23 21:29:55 -0700591 WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
592
David Brownell8ae12a02006-01-08 13:34:19 -0800593 proxy->chip_select = chip->chip_select;
594 proxy->max_speed_hz = chip->max_speed_hz;
David Brownell980a01c2006-06-28 07:47:15 -0700595 proxy->mode = chip->mode;
David Brownell8ae12a02006-01-08 13:34:19 -0800596 proxy->irq = chip->irq;
Grant Likely102eb972008-07-23 21:29:55 -0700597 strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
David Brownell8ae12a02006-01-08 13:34:19 -0800598 proxy->dev.platform_data = (void *) chip->platform_data;
599 proxy->controller_data = chip->controller_data;
600 proxy->controller_state = NULL;
David Brownell8ae12a02006-01-08 13:34:19 -0800601
Grant Likelydc87c982008-05-15 16:50:22 -0600602 status = spi_add_device(proxy);
David Brownell8ae12a02006-01-08 13:34:19 -0800603 if (status < 0) {
Grant Likelydc87c982008-05-15 16:50:22 -0600604 spi_dev_put(proxy);
605 return NULL;
David Brownell8ae12a02006-01-08 13:34:19 -0800606 }
607
David Brownell8ae12a02006-01-08 13:34:19 -0800608 return proxy;
609}
610EXPORT_SYMBOL_GPL(spi_new_device);
611
Geert Uytterhoeven3b1884c2015-11-30 15:28:06 +0100612/**
613 * spi_unregister_device - unregister a single SPI device
614 * @spi: spi_device to unregister
615 *
616 * Start making the passed SPI device vanish. Normally this would be handled
617 * by spi_unregister_master().
618 */
619void spi_unregister_device(struct spi_device *spi)
620{
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +0100621 if (!spi)
622 return;
623
Johan Hovold9846c672017-01-30 17:47:05 +0100624 if (spi->dev.of_node) {
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +0100625 of_node_clear_flag(spi->dev.of_node, OF_POPULATED);
Johan Hovold9846c672017-01-30 17:47:05 +0100626 of_node_put(spi->dev.of_node);
627 }
Octavian Purdila7f244672016-07-08 19:13:11 +0300628 if (ACPI_COMPANION(&spi->dev))
629 acpi_device_clear_enumerated(ACPI_COMPANION(&spi->dev));
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +0100630 device_unregister(&spi->dev);
Geert Uytterhoeven3b1884c2015-11-30 15:28:06 +0100631}
632EXPORT_SYMBOL_GPL(spi_unregister_device);
633
Feng Tang2b9603a2010-08-02 15:52:15 +0800634static void spi_match_master_to_boardinfo(struct spi_master *master,
635 struct spi_board_info *bi)
636{
637 struct spi_device *dev;
638
639 if (master->bus_num != bi->bus_num)
640 return;
641
642 dev = spi_new_device(master, bi);
643 if (!dev)
644 dev_err(master->dev.parent, "can't create new device for %s\n",
645 bi->modalias);
646}
647
David Brownell33e34dc2007-05-08 00:32:21 -0700648/**
649 * spi_register_board_info - register SPI devices for a given board
650 * @info: array of chip descriptors
651 * @n: how many descriptors are provided
652 * Context: can sleep
653 *
David Brownell8ae12a02006-01-08 13:34:19 -0800654 * Board-specific early init code calls this (probably during arch_initcall)
655 * with segments of the SPI device table. Any device nodes are created later,
656 * after the relevant parent SPI controller (bus_num) is defined. We keep
657 * this table of devices forever, so that reloading a controller driver will
658 * not make Linux forget about these hard-wired devices.
659 *
660 * Other code can also call this, e.g. a particular add-on board might provide
661 * SPI devices through its expansion connector, so code initializing that board
662 * would naturally declare its SPI devices.
663 *
664 * The board info passed can safely be __initdata ... but be careful of
665 * any embedded pointers (platform_data, etc), they're copied as-is.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200666 *
667 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -0800668 */
Grant Likelyfd4a3192012-12-07 16:57:14 +0000669int spi_register_board_info(struct spi_board_info const *info, unsigned n)
David Brownell8ae12a02006-01-08 13:34:19 -0800670{
Feng Tang2b9603a2010-08-02 15:52:15 +0800671 struct boardinfo *bi;
672 int i;
David Brownell8ae12a02006-01-08 13:34:19 -0800673
Xiubo Lic7908a32014-09-24 14:30:29 +0800674 if (!n)
675 return -EINVAL;
676
Feng Tang2b9603a2010-08-02 15:52:15 +0800677 bi = kzalloc(n * sizeof(*bi), GFP_KERNEL);
David Brownell8ae12a02006-01-08 13:34:19 -0800678 if (!bi)
679 return -ENOMEM;
David Brownell8ae12a02006-01-08 13:34:19 -0800680
Feng Tang2b9603a2010-08-02 15:52:15 +0800681 for (i = 0; i < n; i++, bi++, info++) {
682 struct spi_master *master;
David Brownell8ae12a02006-01-08 13:34:19 -0800683
Feng Tang2b9603a2010-08-02 15:52:15 +0800684 memcpy(&bi->board_info, info, sizeof(*info));
685 mutex_lock(&board_lock);
686 list_add_tail(&bi->list, &board_list);
687 list_for_each_entry(master, &spi_master_list, list)
688 spi_match_master_to_boardinfo(master, &bi->board_info);
689 mutex_unlock(&board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800690 }
Feng Tang2b9603a2010-08-02 15:52:15 +0800691
692 return 0;
David Brownell8ae12a02006-01-08 13:34:19 -0800693}
694
695/*-------------------------------------------------------------------------*/
696
Mark Brownb1589352013-10-05 11:50:40 +0100697static void spi_set_cs(struct spi_device *spi, bool enable)
698{
699 if (spi->mode & SPI_CS_HIGH)
700 enable = !enable;
701
Andy Shevchenko243f07b2015-10-20 12:28:29 +0300702 if (gpio_is_valid(spi->cs_gpio))
Mark Brownb1589352013-10-05 11:50:40 +0100703 gpio_set_value(spi->cs_gpio, !enable);
704 else if (spi->master->set_cs)
705 spi->master->set_cs(spi, !enable);
706}
707
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200708#ifdef CONFIG_HAS_DMA
Mark Brown6ad45a22014-02-02 13:47:47 +0000709static int spi_map_buf(struct spi_master *master, struct device *dev,
710 struct sg_table *sgt, void *buf, size_t len,
711 enum dma_data_direction dir)
712{
713 const bool vmalloced_buf = is_vmalloc_addr(buf);
Andy Shevchenkodf88e912016-03-09 11:20:00 +0200714 unsigned int max_seg_size = dma_get_max_seg_size(dev);
Vignesh Rb1b81532016-08-17 15:22:36 +0530715#ifdef CONFIG_HIGHMEM
716 const bool kmap_buf = ((unsigned long)buf >= PKMAP_BASE &&
717 (unsigned long)buf < (PKMAP_BASE +
718 (LAST_PKMAP * PAGE_SIZE)));
719#else
720 const bool kmap_buf = false;
721#endif
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500722 int desc_len;
723 int sgs;
Mark Brown6ad45a22014-02-02 13:47:47 +0000724 struct page *vm_page;
725 void *sg_buf;
726 size_t min;
727 int i, ret;
728
Vignesh Rb1b81532016-08-17 15:22:36 +0530729 if (vmalloced_buf || kmap_buf) {
Andy Shevchenkodf88e912016-03-09 11:20:00 +0200730 desc_len = min_t(int, max_seg_size, PAGE_SIZE);
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500731 sgs = DIV_ROUND_UP(len + offset_in_page(buf), desc_len);
Vignesh R0569a882016-04-25 15:14:00 +0530732 } else if (virt_addr_valid(buf)) {
Andy Shevchenkodf88e912016-03-09 11:20:00 +0200733 desc_len = min_t(int, max_seg_size, master->max_dma_len);
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500734 sgs = DIV_ROUND_UP(len, desc_len);
Vignesh R0569a882016-04-25 15:14:00 +0530735 } else {
736 return -EINVAL;
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500737 }
738
Mark Brown6ad45a22014-02-02 13:47:47 +0000739 ret = sg_alloc_table(sgt, sgs, GFP_KERNEL);
740 if (ret != 0)
741 return ret;
742
743 for (i = 0; i < sgs; i++) {
Mark Brown6ad45a22014-02-02 13:47:47 +0000744
Vignesh Rb1b81532016-08-17 15:22:36 +0530745 if (vmalloced_buf || kmap_buf) {
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500746 min = min_t(size_t,
747 len, desc_len - offset_in_page(buf));
Vignesh Rb1b81532016-08-17 15:22:36 +0530748 if (vmalloced_buf)
749 vm_page = vmalloc_to_page(buf);
750 else
751 vm_page = kmap_to_page(buf);
Mark Brown6ad45a22014-02-02 13:47:47 +0000752 if (!vm_page) {
753 sg_free_table(sgt);
754 return -ENOMEM;
755 }
Charles Keepaxc1aefbd2014-11-17 09:14:31 +0000756 sg_set_page(&sgt->sgl[i], vm_page,
757 min, offset_in_page(buf));
Mark Brown6ad45a22014-02-02 13:47:47 +0000758 } else {
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500759 min = min_t(size_t, len, desc_len);
Mark Brown6ad45a22014-02-02 13:47:47 +0000760 sg_buf = buf;
Charles Keepaxc1aefbd2014-11-17 09:14:31 +0000761 sg_set_buf(&sgt->sgl[i], sg_buf, min);
Mark Brown6ad45a22014-02-02 13:47:47 +0000762 }
763
Mark Brown6ad45a22014-02-02 13:47:47 +0000764 buf += min;
765 len -= min;
766 }
767
768 ret = dma_map_sg(dev, sgt->sgl, sgt->nents, dir);
Geert Uytterhoeven89e4b662014-07-10 15:29:32 +0200769 if (!ret)
770 ret = -ENOMEM;
Mark Brown6ad45a22014-02-02 13:47:47 +0000771 if (ret < 0) {
772 sg_free_table(sgt);
773 return ret;
774 }
775
776 sgt->nents = ret;
777
778 return 0;
779}
780
781static void spi_unmap_buf(struct spi_master *master, struct device *dev,
782 struct sg_table *sgt, enum dma_data_direction dir)
783{
784 if (sgt->orig_nents) {
785 dma_unmap_sg(dev, sgt->sgl, sgt->orig_nents, dir);
786 sg_free_table(sgt);
787 }
788}
789
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200790static int __spi_map_msg(struct spi_master *master, struct spi_message *msg)
Mark Brown99adef32014-01-16 12:22:43 +0000791{
Mark Brown99adef32014-01-16 12:22:43 +0000792 struct device *tx_dev, *rx_dev;
793 struct spi_transfer *xfer;
Mark Brown6ad45a22014-02-02 13:47:47 +0000794 int ret;
Mark Brown3a2eba92014-01-28 20:17:03 +0000795
Mark Brown6ad45a22014-02-02 13:47:47 +0000796 if (!master->can_dma)
Mark Brown99adef32014-01-16 12:22:43 +0000797 return 0;
798
Leilk Liuc37f45b2015-07-23 17:10:40 +0800799 if (master->dma_tx)
800 tx_dev = master->dma_tx->device->dev;
801 else
Daniel Kurtzc52829f2017-01-27 00:21:53 +0800802 tx_dev = master->dev.parent;
Leilk Liuc37f45b2015-07-23 17:10:40 +0800803
804 if (master->dma_rx)
805 rx_dev = master->dma_rx->device->dev;
806 else
Daniel Kurtzc52829f2017-01-27 00:21:53 +0800807 rx_dev = master->dev.parent;
Mark Brown99adef32014-01-16 12:22:43 +0000808
809 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
810 if (!master->can_dma(master, msg->spi, xfer))
811 continue;
812
813 if (xfer->tx_buf != NULL) {
Mark Brown6ad45a22014-02-02 13:47:47 +0000814 ret = spi_map_buf(master, tx_dev, &xfer->tx_sg,
815 (void *)xfer->tx_buf, xfer->len,
816 DMA_TO_DEVICE);
817 if (ret != 0)
818 return ret;
Mark Brown99adef32014-01-16 12:22:43 +0000819 }
820
821 if (xfer->rx_buf != NULL) {
Mark Brown6ad45a22014-02-02 13:47:47 +0000822 ret = spi_map_buf(master, rx_dev, &xfer->rx_sg,
823 xfer->rx_buf, xfer->len,
824 DMA_FROM_DEVICE);
825 if (ret != 0) {
826 spi_unmap_buf(master, tx_dev, &xfer->tx_sg,
827 DMA_TO_DEVICE);
828 return ret;
Mark Brown99adef32014-01-16 12:22:43 +0000829 }
830 }
831 }
832
833 master->cur_msg_mapped = true;
834
835 return 0;
836}
837
Martin Sperl4b786452015-05-25 10:13:10 +0000838static int __spi_unmap_msg(struct spi_master *master, struct spi_message *msg)
Mark Brown99adef32014-01-16 12:22:43 +0000839{
840 struct spi_transfer *xfer;
841 struct device *tx_dev, *rx_dev;
842
Mark Brown6ad45a22014-02-02 13:47:47 +0000843 if (!master->cur_msg_mapped || !master->can_dma)
Mark Brown99adef32014-01-16 12:22:43 +0000844 return 0;
845
Leilk Liuc37f45b2015-07-23 17:10:40 +0800846 if (master->dma_tx)
847 tx_dev = master->dma_tx->device->dev;
848 else
Daniel Kurtzc52829f2017-01-27 00:21:53 +0800849 tx_dev = master->dev.parent;
Leilk Liuc37f45b2015-07-23 17:10:40 +0800850
851 if (master->dma_rx)
852 rx_dev = master->dma_rx->device->dev;
853 else
Daniel Kurtzc52829f2017-01-27 00:21:53 +0800854 rx_dev = master->dev.parent;
Mark Brown99adef32014-01-16 12:22:43 +0000855
856 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
857 if (!master->can_dma(master, msg->spi, xfer))
858 continue;
859
Mark Brown6ad45a22014-02-02 13:47:47 +0000860 spi_unmap_buf(master, rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
861 spi_unmap_buf(master, tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
Mark Brown99adef32014-01-16 12:22:43 +0000862 }
863
864 return 0;
865}
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200866#else /* !CONFIG_HAS_DMA */
Vignesh Rf4502dd2016-06-08 12:18:31 +0530867static inline int spi_map_buf(struct spi_master *master,
868 struct device *dev, struct sg_table *sgt,
869 void *buf, size_t len,
870 enum dma_data_direction dir)
871{
872 return -EINVAL;
873}
874
875static inline void spi_unmap_buf(struct spi_master *master,
876 struct device *dev, struct sg_table *sgt,
877 enum dma_data_direction dir)
878{
879}
880
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200881static inline int __spi_map_msg(struct spi_master *master,
882 struct spi_message *msg)
883{
884 return 0;
885}
886
Martin Sperl4b786452015-05-25 10:13:10 +0000887static inline int __spi_unmap_msg(struct spi_master *master,
888 struct spi_message *msg)
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200889{
890 return 0;
891}
892#endif /* !CONFIG_HAS_DMA */
893
Martin Sperl4b786452015-05-25 10:13:10 +0000894static inline int spi_unmap_msg(struct spi_master *master,
895 struct spi_message *msg)
896{
897 struct spi_transfer *xfer;
898
899 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
900 /*
901 * Restore the original value of tx_buf or rx_buf if they are
902 * NULL.
903 */
904 if (xfer->tx_buf == master->dummy_tx)
905 xfer->tx_buf = NULL;
906 if (xfer->rx_buf == master->dummy_rx)
907 xfer->rx_buf = NULL;
908 }
909
910 return __spi_unmap_msg(master, msg);
911}
912
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200913static int spi_map_msg(struct spi_master *master, struct spi_message *msg)
914{
915 struct spi_transfer *xfer;
916 void *tmp;
917 unsigned int max_tx, max_rx;
918
919 if (master->flags & (SPI_MASTER_MUST_RX | SPI_MASTER_MUST_TX)) {
920 max_tx = 0;
921 max_rx = 0;
922
923 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
924 if ((master->flags & SPI_MASTER_MUST_TX) &&
925 !xfer->tx_buf)
926 max_tx = max(xfer->len, max_tx);
927 if ((master->flags & SPI_MASTER_MUST_RX) &&
928 !xfer->rx_buf)
929 max_rx = max(xfer->len, max_rx);
930 }
931
932 if (max_tx) {
933 tmp = krealloc(master->dummy_tx, max_tx,
934 GFP_KERNEL | GFP_DMA);
935 if (!tmp)
936 return -ENOMEM;
937 master->dummy_tx = tmp;
938 memset(tmp, 0, max_tx);
939 }
940
941 if (max_rx) {
942 tmp = krealloc(master->dummy_rx, max_rx,
943 GFP_KERNEL | GFP_DMA);
944 if (!tmp)
945 return -ENOMEM;
946 master->dummy_rx = tmp;
947 }
948
949 if (max_tx || max_rx) {
950 list_for_each_entry(xfer, &msg->transfers,
951 transfer_list) {
952 if (!xfer->tx_buf)
953 xfer->tx_buf = master->dummy_tx;
954 if (!xfer->rx_buf)
955 xfer->rx_buf = master->dummy_rx;
956 }
957 }
958 }
959
960 return __spi_map_msg(master, msg);
961}
Mark Brown99adef32014-01-16 12:22:43 +0000962
Mark Brownb1589352013-10-05 11:50:40 +0100963/*
964 * spi_transfer_one_message - Default implementation of transfer_one_message()
965 *
966 * This is a standard implementation of transfer_one_message() for
Moritz Fischer8ba811a2016-05-03 11:59:30 -0700967 * drivers which implement a transfer_one() operation. It provides
Mark Brownb1589352013-10-05 11:50:40 +0100968 * standard handling of delays and chip select management.
969 */
970static int spi_transfer_one_message(struct spi_master *master,
971 struct spi_message *msg)
972{
973 struct spi_transfer *xfer;
Mark Brownb1589352013-10-05 11:50:40 +0100974 bool keep_cs = false;
975 int ret = 0;
Sien Wud0716dd2016-09-01 18:24:29 -0500976 unsigned long long ms = 1;
Martin Sperleca2ebc2015-06-22 13:00:36 +0000977 struct spi_statistics *statm = &master->statistics;
978 struct spi_statistics *stats = &msg->spi->statistics;
Mark Brownb1589352013-10-05 11:50:40 +0100979
980 spi_set_cs(msg->spi, true);
981
Martin Sperleca2ebc2015-06-22 13:00:36 +0000982 SPI_STATISTICS_INCREMENT_FIELD(statm, messages);
983 SPI_STATISTICS_INCREMENT_FIELD(stats, messages);
984
Mark Brownb1589352013-10-05 11:50:40 +0100985 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
986 trace_spi_transfer_start(msg, xfer);
987
Martin Sperleca2ebc2015-06-22 13:00:36 +0000988 spi_statistics_add_transfer_stats(statm, xfer, master);
989 spi_statistics_add_transfer_stats(stats, xfer, master);
990
Mark Brown38ec10f2014-08-16 16:27:41 +0100991 if (xfer->tx_buf || xfer->rx_buf) {
992 reinit_completion(&master->xfer_completion);
Mark Brownb1589352013-10-05 11:50:40 +0100993
Mark Brown38ec10f2014-08-16 16:27:41 +0100994 ret = master->transfer_one(master, msg->spi, xfer);
995 if (ret < 0) {
Martin Sperleca2ebc2015-06-22 13:00:36 +0000996 SPI_STATISTICS_INCREMENT_FIELD(statm,
997 errors);
998 SPI_STATISTICS_INCREMENT_FIELD(stats,
999 errors);
Mark Brown38ec10f2014-08-16 16:27:41 +01001000 dev_err(&msg->spi->dev,
1001 "SPI transfer failed: %d\n", ret);
1002 goto out;
1003 }
Mark Brownb1589352013-10-05 11:50:40 +01001004
Mark Brown38ec10f2014-08-16 16:27:41 +01001005 if (ret > 0) {
1006 ret = 0;
Sien Wud0716dd2016-09-01 18:24:29 -05001007 ms = 8LL * 1000LL * xfer->len;
1008 do_div(ms, xfer->speed_hz);
Hauke Mehrtens5da64152017-04-17 01:38:05 +02001009 ms += ms + 200; /* some tolerance */
Mark Brown16a0ce42014-01-30 22:16:41 +00001010
Sien Wud0716dd2016-09-01 18:24:29 -05001011 if (ms > UINT_MAX)
1012 ms = UINT_MAX;
1013
Mark Brown38ec10f2014-08-16 16:27:41 +01001014 ms = wait_for_completion_timeout(&master->xfer_completion,
1015 msecs_to_jiffies(ms));
1016 }
Mark Brown16a0ce42014-01-30 22:16:41 +00001017
Mark Brown38ec10f2014-08-16 16:27:41 +01001018 if (ms == 0) {
Martin Sperleca2ebc2015-06-22 13:00:36 +00001019 SPI_STATISTICS_INCREMENT_FIELD(statm,
1020 timedout);
1021 SPI_STATISTICS_INCREMENT_FIELD(stats,
1022 timedout);
Mark Brown38ec10f2014-08-16 16:27:41 +01001023 dev_err(&msg->spi->dev,
1024 "SPI transfer timed out\n");
1025 msg->status = -ETIMEDOUT;
1026 }
1027 } else {
1028 if (xfer->len)
1029 dev_err(&msg->spi->dev,
1030 "Bufferless transfer has length %u\n",
1031 xfer->len);
Axel Lin13a42792014-01-18 22:05:22 +08001032 }
Mark Brownb1589352013-10-05 11:50:40 +01001033
1034 trace_spi_transfer_stop(msg, xfer);
1035
1036 if (msg->status != -EINPROGRESS)
1037 goto out;
1038
1039 if (xfer->delay_usecs)
1040 udelay(xfer->delay_usecs);
1041
1042 if (xfer->cs_change) {
1043 if (list_is_last(&xfer->transfer_list,
1044 &msg->transfers)) {
1045 keep_cs = true;
1046 } else {
Mark Brown0b73aa62014-03-29 23:48:07 +00001047 spi_set_cs(msg->spi, false);
1048 udelay(10);
1049 spi_set_cs(msg->spi, true);
Mark Brownb1589352013-10-05 11:50:40 +01001050 }
1051 }
1052
1053 msg->actual_length += xfer->len;
1054 }
1055
1056out:
1057 if (ret != 0 || !keep_cs)
1058 spi_set_cs(msg->spi, false);
1059
1060 if (msg->status == -EINPROGRESS)
1061 msg->status = ret;
1062
Geert Uytterhoevenff61eb42015-04-07 20:39:19 +02001063 if (msg->status && master->handle_err)
Andy Shevchenkob716c4f2015-02-27 17:34:15 +02001064 master->handle_err(master, msg);
1065
Martin Sperld780c372015-12-14 15:20:18 +00001066 spi_res_release(master, msg);
1067
Mark Brownb1589352013-10-05 11:50:40 +01001068 spi_finalize_current_message(master);
1069
1070 return ret;
1071}
1072
1073/**
1074 * spi_finalize_current_transfer - report completion of a transfer
Thierry Reding2c675682014-08-08 13:02:36 +02001075 * @master: the master reporting completion
Mark Brownb1589352013-10-05 11:50:40 +01001076 *
1077 * Called by SPI drivers using the core transfer_one_message()
1078 * implementation to notify it that the current interrupt driven
Geert Uytterhoeven9e8f4882014-01-21 16:10:05 +01001079 * transfer has finished and the next one may be scheduled.
Mark Brownb1589352013-10-05 11:50:40 +01001080 */
1081void spi_finalize_current_transfer(struct spi_master *master)
1082{
1083 complete(&master->xfer_completion);
1084}
1085EXPORT_SYMBOL_GPL(spi_finalize_current_transfer);
1086
Linus Walleijffbbdd212012-02-22 10:05:38 +01001087/**
Mark Brownfc9e0f72014-12-10 13:46:33 +00001088 * __spi_pump_messages - function which processes spi message queue
1089 * @master: master to process queue for
1090 * @in_kthread: true if we are in the context of the message pump thread
Linus Walleijffbbdd212012-02-22 10:05:38 +01001091 *
1092 * This function checks if there is any spi message in the queue that
1093 * needs processing and if so call out to the driver to initialize hardware
1094 * and transfer each message.
1095 *
Mark Brown0461a412014-12-09 21:38:05 +00001096 * Note that it is called both from the kthread itself and also from
1097 * inside spi_sync(); the queue extraction handling at the top of the
1098 * function should deal with this safely.
Linus Walleijffbbdd212012-02-22 10:05:38 +01001099 */
Mark Brownef4d96e2016-07-21 23:53:31 +01001100static void __spi_pump_messages(struct spi_master *master, bool in_kthread)
Linus Walleijffbbdd212012-02-22 10:05:38 +01001101{
Linus Walleijffbbdd212012-02-22 10:05:38 +01001102 unsigned long flags;
1103 bool was_busy = false;
1104 int ret;
1105
Mark Brown983aee52014-12-09 19:46:56 +00001106 /* Lock queue */
Linus Walleijffbbdd212012-02-22 10:05:38 +01001107 spin_lock_irqsave(&master->queue_lock, flags);
Mark Brown983aee52014-12-09 19:46:56 +00001108
1109 /* Make sure we are not already running a message */
1110 if (master->cur_msg) {
1111 spin_unlock_irqrestore(&master->queue_lock, flags);
1112 return;
1113 }
1114
Mark Brown0461a412014-12-09 21:38:05 +00001115 /* If another context is idling the device then defer */
1116 if (master->idling) {
Petr Mladek39891442016-10-11 13:55:20 -07001117 kthread_queue_work(&master->kworker, &master->pump_messages);
Mark Brown0461a412014-12-09 21:38:05 +00001118 spin_unlock_irqrestore(&master->queue_lock, flags);
1119 return;
1120 }
1121
Mark Brown983aee52014-12-09 19:46:56 +00001122 /* Check if the queue is idle */
Linus Walleijffbbdd212012-02-22 10:05:38 +01001123 if (list_empty(&master->queue) || !master->running) {
Bryan Freedb0b36b82013-03-13 11:17:40 -07001124 if (!master->busy) {
1125 spin_unlock_irqrestore(&master->queue_lock, flags);
1126 return;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001127 }
Mark Brownfc9e0f72014-12-10 13:46:33 +00001128
1129 /* Only do teardown in the thread */
1130 if (!in_kthread) {
Petr Mladek39891442016-10-11 13:55:20 -07001131 kthread_queue_work(&master->kworker,
Mark Brownfc9e0f72014-12-10 13:46:33 +00001132 &master->pump_messages);
1133 spin_unlock_irqrestore(&master->queue_lock, flags);
1134 return;
1135 }
1136
Linus Walleijffbbdd212012-02-22 10:05:38 +01001137 master->busy = false;
Mark Brown0461a412014-12-09 21:38:05 +00001138 master->idling = true;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001139 spin_unlock_irqrestore(&master->queue_lock, flags);
Mark Brown0461a412014-12-09 21:38:05 +00001140
Mark Brown3a2eba92014-01-28 20:17:03 +00001141 kfree(master->dummy_rx);
1142 master->dummy_rx = NULL;
1143 kfree(master->dummy_tx);
1144 master->dummy_tx = NULL;
Bryan Freedb0b36b82013-03-13 11:17:40 -07001145 if (master->unprepare_transfer_hardware &&
1146 master->unprepare_transfer_hardware(master))
1147 dev_err(&master->dev,
1148 "failed to unprepare transfer hardware\n");
Mark Brown49834de2013-07-28 14:47:02 +01001149 if (master->auto_runtime_pm) {
1150 pm_runtime_mark_last_busy(master->dev.parent);
1151 pm_runtime_put_autosuspend(master->dev.parent);
1152 }
Mark Brown56ec1972013-10-07 19:33:53 +01001153 trace_spi_master_idle(master);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001154
Mark Brown0461a412014-12-09 21:38:05 +00001155 spin_lock_irqsave(&master->queue_lock, flags);
1156 master->idling = false;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001157 spin_unlock_irqrestore(&master->queue_lock, flags);
1158 return;
1159 }
Linus Walleijffbbdd212012-02-22 10:05:38 +01001160
Linus Walleijffbbdd212012-02-22 10:05:38 +01001161 /* Extract head of queue */
1162 master->cur_msg =
Axel Lina89e2d22014-01-09 16:03:58 +08001163 list_first_entry(&master->queue, struct spi_message, queue);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001164
1165 list_del_init(&master->cur_msg->queue);
1166 if (master->busy)
1167 was_busy = true;
1168 else
1169 master->busy = true;
1170 spin_unlock_irqrestore(&master->queue_lock, flags);
1171
Mark Brownef4d96e2016-07-21 23:53:31 +01001172 mutex_lock(&master->io_mutex);
1173
Mark Brown49834de2013-07-28 14:47:02 +01001174 if (!was_busy && master->auto_runtime_pm) {
1175 ret = pm_runtime_get_sync(master->dev.parent);
1176 if (ret < 0) {
1177 dev_err(&master->dev, "Failed to power device: %d\n",
1178 ret);
Mark Brown764f21662016-08-09 17:45:33 +01001179 mutex_unlock(&master->io_mutex);
Mark Brown49834de2013-07-28 14:47:02 +01001180 return;
1181 }
1182 }
1183
Mark Brown56ec1972013-10-07 19:33:53 +01001184 if (!was_busy)
1185 trace_spi_master_busy(master);
1186
Shubhrajyoti D7dfd2bd2012-05-10 19:20:41 +05301187 if (!was_busy && master->prepare_transfer_hardware) {
Linus Walleijffbbdd212012-02-22 10:05:38 +01001188 ret = master->prepare_transfer_hardware(master);
1189 if (ret) {
1190 dev_err(&master->dev,
1191 "failed to prepare transfer hardware\n");
Mark Brown49834de2013-07-28 14:47:02 +01001192
1193 if (master->auto_runtime_pm)
1194 pm_runtime_put(master->dev.parent);
Mark Brown764f21662016-08-09 17:45:33 +01001195 mutex_unlock(&master->io_mutex);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001196 return;
1197 }
1198 }
1199
Mark Brown56ec1972013-10-07 19:33:53 +01001200 trace_spi_message_start(master->cur_msg);
1201
Mark Brown2841a5f2013-10-05 00:23:12 +01001202 if (master->prepare_message) {
1203 ret = master->prepare_message(master, master->cur_msg);
1204 if (ret) {
1205 dev_err(&master->dev,
1206 "failed to prepare message: %d\n", ret);
1207 master->cur_msg->status = ret;
1208 spi_finalize_current_message(master);
Jon Hunter49023d22016-03-08 12:28:20 +00001209 goto out;
Mark Brown2841a5f2013-10-05 00:23:12 +01001210 }
1211 master->cur_msg_prepared = true;
1212 }
1213
Mark Brown99adef32014-01-16 12:22:43 +00001214 ret = spi_map_msg(master, master->cur_msg);
1215 if (ret) {
1216 master->cur_msg->status = ret;
1217 spi_finalize_current_message(master);
Jon Hunter49023d22016-03-08 12:28:20 +00001218 goto out;
Mark Brown99adef32014-01-16 12:22:43 +00001219 }
1220
Linus Walleijffbbdd212012-02-22 10:05:38 +01001221 ret = master->transfer_one_message(master, master->cur_msg);
1222 if (ret) {
1223 dev_err(&master->dev,
Geert Uytterhoeven1f802f82014-01-28 10:33:03 +01001224 "failed to transfer one message from queue\n");
Jon Hunter49023d22016-03-08 12:28:20 +00001225 goto out;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001226 }
Jon Hunter49023d22016-03-08 12:28:20 +00001227
1228out:
Mark Brownef4d96e2016-07-21 23:53:31 +01001229 mutex_unlock(&master->io_mutex);
Mark Brown62826972016-02-15 18:28:02 +00001230
1231 /* Prod the scheduler in case transfer_one() was busy waiting */
Jon Hunter49023d22016-03-08 12:28:20 +00001232 if (!ret)
1233 cond_resched();
Linus Walleijffbbdd212012-02-22 10:05:38 +01001234}
1235
Mark Brownfc9e0f72014-12-10 13:46:33 +00001236/**
1237 * spi_pump_messages - kthread work function which processes spi message queue
1238 * @work: pointer to kthread work struct contained in the master struct
1239 */
1240static void spi_pump_messages(struct kthread_work *work)
1241{
1242 struct spi_master *master =
1243 container_of(work, struct spi_master, pump_messages);
1244
Mark Brownef4d96e2016-07-21 23:53:31 +01001245 __spi_pump_messages(master, true);
Mark Brownfc9e0f72014-12-10 13:46:33 +00001246}
1247
Linus Walleijffbbdd212012-02-22 10:05:38 +01001248static int spi_init_queue(struct spi_master *master)
1249{
1250 struct sched_param param = { .sched_priority = MAX_RT_PRIO - 1 };
1251
Linus Walleijffbbdd212012-02-22 10:05:38 +01001252 master->running = false;
1253 master->busy = false;
1254
Petr Mladek39891442016-10-11 13:55:20 -07001255 kthread_init_worker(&master->kworker);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001256 master->kworker_task = kthread_run(kthread_worker_fn,
Kees Cookf1701682013-07-03 15:04:58 -07001257 &master->kworker, "%s",
Linus Walleijffbbdd212012-02-22 10:05:38 +01001258 dev_name(&master->dev));
1259 if (IS_ERR(master->kworker_task)) {
1260 dev_err(&master->dev, "failed to create message pump task\n");
Jarkko Nikula98a8f5a2014-12-04 11:02:25 +02001261 return PTR_ERR(master->kworker_task);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001262 }
Petr Mladek39891442016-10-11 13:55:20 -07001263 kthread_init_work(&master->pump_messages, spi_pump_messages);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001264
1265 /*
1266 * Master config will indicate if this controller should run the
1267 * message pump with high (realtime) priority to reduce the transfer
1268 * latency on the bus by minimising the delay between a transfer
1269 * request and the scheduling of the message pump thread. Without this
1270 * setting the message pump thread will remain at default priority.
1271 */
1272 if (master->rt) {
1273 dev_info(&master->dev,
1274 "will run message pump with realtime priority\n");
1275 sched_setscheduler(master->kworker_task, SCHED_FIFO, &param);
1276 }
1277
1278 return 0;
1279}
1280
1281/**
1282 * spi_get_next_queued_message() - called by driver to check for queued
1283 * messages
1284 * @master: the master to check for queued messages
1285 *
1286 * If there are more messages in the queue, the next message is returned from
1287 * this call.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001288 *
1289 * Return: the next message in the queue, else NULL if the queue is empty.
Linus Walleijffbbdd212012-02-22 10:05:38 +01001290 */
1291struct spi_message *spi_get_next_queued_message(struct spi_master *master)
1292{
1293 struct spi_message *next;
1294 unsigned long flags;
1295
1296 /* get a pointer to the next message, if any */
1297 spin_lock_irqsave(&master->queue_lock, flags);
Axel Lin1cfd97f2014-01-02 15:16:40 +08001298 next = list_first_entry_or_null(&master->queue, struct spi_message,
1299 queue);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001300 spin_unlock_irqrestore(&master->queue_lock, flags);
1301
1302 return next;
1303}
1304EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
1305
1306/**
1307 * spi_finalize_current_message() - the current message is complete
1308 * @master: the master to return the message to
1309 *
1310 * Called by the driver to notify the core that the message in the front of the
1311 * queue is complete and can be removed from the queue.
1312 */
1313void spi_finalize_current_message(struct spi_master *master)
1314{
1315 struct spi_message *mesg;
1316 unsigned long flags;
Mark Brown2841a5f2013-10-05 00:23:12 +01001317 int ret;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001318
1319 spin_lock_irqsave(&master->queue_lock, flags);
1320 mesg = master->cur_msg;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001321 spin_unlock_irqrestore(&master->queue_lock, flags);
1322
Mark Brown99adef32014-01-16 12:22:43 +00001323 spi_unmap_msg(master, mesg);
1324
Mark Brown2841a5f2013-10-05 00:23:12 +01001325 if (master->cur_msg_prepared && master->unprepare_message) {
1326 ret = master->unprepare_message(master, mesg);
1327 if (ret) {
1328 dev_err(&master->dev,
1329 "failed to unprepare message: %d\n", ret);
1330 }
1331 }
Uwe Kleine-König391949b2015-03-18 11:27:28 +01001332
Martin Sperl8e76ef82015-05-10 07:50:45 +00001333 spin_lock_irqsave(&master->queue_lock, flags);
1334 master->cur_msg = NULL;
Mark Brown2841a5f2013-10-05 00:23:12 +01001335 master->cur_msg_prepared = false;
Petr Mladek39891442016-10-11 13:55:20 -07001336 kthread_queue_work(&master->kworker, &master->pump_messages);
Martin Sperl8e76ef82015-05-10 07:50:45 +00001337 spin_unlock_irqrestore(&master->queue_lock, flags);
1338
1339 trace_spi_message_done(mesg);
Mark Brown2841a5f2013-10-05 00:23:12 +01001340
Linus Walleijffbbdd212012-02-22 10:05:38 +01001341 mesg->state = NULL;
1342 if (mesg->complete)
1343 mesg->complete(mesg->context);
1344}
1345EXPORT_SYMBOL_GPL(spi_finalize_current_message);
1346
1347static int spi_start_queue(struct spi_master *master)
1348{
1349 unsigned long flags;
1350
1351 spin_lock_irqsave(&master->queue_lock, flags);
1352
1353 if (master->running || master->busy) {
1354 spin_unlock_irqrestore(&master->queue_lock, flags);
1355 return -EBUSY;
1356 }
1357
1358 master->running = true;
1359 master->cur_msg = NULL;
1360 spin_unlock_irqrestore(&master->queue_lock, flags);
1361
Petr Mladek39891442016-10-11 13:55:20 -07001362 kthread_queue_work(&master->kworker, &master->pump_messages);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001363
1364 return 0;
1365}
1366
1367static int spi_stop_queue(struct spi_master *master)
1368{
1369 unsigned long flags;
1370 unsigned limit = 500;
1371 int ret = 0;
1372
1373 spin_lock_irqsave(&master->queue_lock, flags);
1374
1375 /*
1376 * This is a bit lame, but is optimized for the common execution path.
1377 * A wait_queue on the master->busy could be used, but then the common
1378 * execution path (pump_messages) would be required to call wake_up or
1379 * friends on every SPI message. Do this instead.
1380 */
1381 while ((!list_empty(&master->queue) || master->busy) && limit--) {
1382 spin_unlock_irqrestore(&master->queue_lock, flags);
Axel Linf97b26b2014-02-21 09:15:18 +08001383 usleep_range(10000, 11000);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001384 spin_lock_irqsave(&master->queue_lock, flags);
1385 }
1386
1387 if (!list_empty(&master->queue) || master->busy)
1388 ret = -EBUSY;
1389 else
1390 master->running = false;
1391
1392 spin_unlock_irqrestore(&master->queue_lock, flags);
1393
1394 if (ret) {
1395 dev_warn(&master->dev,
1396 "could not stop message queue\n");
1397 return ret;
1398 }
1399 return ret;
1400}
1401
1402static int spi_destroy_queue(struct spi_master *master)
1403{
1404 int ret;
1405
1406 ret = spi_stop_queue(master);
1407
1408 /*
Petr Mladek39891442016-10-11 13:55:20 -07001409 * kthread_flush_worker will block until all work is done.
Linus Walleijffbbdd212012-02-22 10:05:38 +01001410 * If the reason that stop_queue timed out is that the work will never
1411 * finish, then it does no good to call flush/stop thread, so
1412 * return anyway.
1413 */
1414 if (ret) {
1415 dev_err(&master->dev, "problem destroying queue\n");
1416 return ret;
1417 }
1418
Petr Mladek39891442016-10-11 13:55:20 -07001419 kthread_flush_worker(&master->kworker);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001420 kthread_stop(master->kworker_task);
1421
1422 return 0;
1423}
1424
Mark Brown0461a412014-12-09 21:38:05 +00001425static int __spi_queued_transfer(struct spi_device *spi,
1426 struct spi_message *msg,
1427 bool need_pump)
Linus Walleijffbbdd212012-02-22 10:05:38 +01001428{
1429 struct spi_master *master = spi->master;
1430 unsigned long flags;
1431
1432 spin_lock_irqsave(&master->queue_lock, flags);
1433
1434 if (!master->running) {
1435 spin_unlock_irqrestore(&master->queue_lock, flags);
1436 return -ESHUTDOWN;
1437 }
1438 msg->actual_length = 0;
1439 msg->status = -EINPROGRESS;
1440
1441 list_add_tail(&msg->queue, &master->queue);
Mark Brown0461a412014-12-09 21:38:05 +00001442 if (!master->busy && need_pump)
Petr Mladek39891442016-10-11 13:55:20 -07001443 kthread_queue_work(&master->kworker, &master->pump_messages);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001444
1445 spin_unlock_irqrestore(&master->queue_lock, flags);
1446 return 0;
1447}
1448
Mark Brown0461a412014-12-09 21:38:05 +00001449/**
1450 * spi_queued_transfer - transfer function for queued transfers
1451 * @spi: spi device which is requesting transfer
1452 * @msg: spi message which is to handled is queued to driver queue
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001453 *
1454 * Return: zero on success, else a negative error code.
Mark Brown0461a412014-12-09 21:38:05 +00001455 */
1456static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
1457{
1458 return __spi_queued_transfer(spi, msg, true);
1459}
1460
Linus Walleijffbbdd212012-02-22 10:05:38 +01001461static int spi_master_initialize_queue(struct spi_master *master)
1462{
1463 int ret;
1464
Linus Walleijffbbdd212012-02-22 10:05:38 +01001465 master->transfer = spi_queued_transfer;
Mark Brownb1589352013-10-05 11:50:40 +01001466 if (!master->transfer_one_message)
1467 master->transfer_one_message = spi_transfer_one_message;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001468
1469 /* Initialize and start queue */
1470 ret = spi_init_queue(master);
1471 if (ret) {
1472 dev_err(&master->dev, "problem initializing queue\n");
1473 goto err_init_queue;
1474 }
Mark Brownc3676d52014-05-01 10:47:52 -07001475 master->queued = true;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001476 ret = spi_start_queue(master);
1477 if (ret) {
1478 dev_err(&master->dev, "problem starting queue\n");
1479 goto err_start_queue;
1480 }
1481
1482 return 0;
1483
1484err_start_queue:
Linus Walleijffbbdd212012-02-22 10:05:38 +01001485 spi_destroy_queue(master);
Mark Brownc3676d52014-05-01 10:47:52 -07001486err_init_queue:
Linus Walleijffbbdd212012-02-22 10:05:38 +01001487 return ret;
1488}
1489
1490/*-------------------------------------------------------------------------*/
1491
Andreas Larsson7cb94362012-12-04 15:09:38 +01001492#if defined(CONFIG_OF)
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001493static struct spi_device *
1494of_register_spi_device(struct spi_master *master, struct device_node *nc)
1495{
1496 struct spi_device *spi;
1497 int rc;
1498 u32 value;
1499
1500 /* Alloc an spi_device */
1501 spi = spi_alloc_device(master);
1502 if (!spi) {
1503 dev_err(&master->dev, "spi_device alloc error for %s\n",
1504 nc->full_name);
1505 rc = -ENOMEM;
1506 goto err_out;
1507 }
1508
1509 /* Select device driver */
1510 rc = of_modalias_node(nc, spi->modalias,
1511 sizeof(spi->modalias));
1512 if (rc < 0) {
1513 dev_err(&master->dev, "cannot find modalias for %s\n",
1514 nc->full_name);
1515 goto err_out;
1516 }
1517
1518 /* Device address */
1519 rc = of_property_read_u32(nc, "reg", &value);
1520 if (rc) {
1521 dev_err(&master->dev, "%s has no valid 'reg' property (%d)\n",
1522 nc->full_name, rc);
1523 goto err_out;
1524 }
1525 spi->chip_select = value;
1526
1527 /* Mode (clock phase/polarity/etc.) */
1528 if (of_find_property(nc, "spi-cpha", NULL))
1529 spi->mode |= SPI_CPHA;
1530 if (of_find_property(nc, "spi-cpol", NULL))
1531 spi->mode |= SPI_CPOL;
1532 if (of_find_property(nc, "spi-cs-high", NULL))
1533 spi->mode |= SPI_CS_HIGH;
1534 if (of_find_property(nc, "spi-3wire", NULL))
1535 spi->mode |= SPI_3WIRE;
1536 if (of_find_property(nc, "spi-lsb-first", NULL))
1537 spi->mode |= SPI_LSB_FIRST;
1538
1539 /* Device DUAL/QUAD mode */
1540 if (!of_property_read_u32(nc, "spi-tx-bus-width", &value)) {
1541 switch (value) {
1542 case 1:
1543 break;
1544 case 2:
1545 spi->mode |= SPI_TX_DUAL;
1546 break;
1547 case 4:
1548 spi->mode |= SPI_TX_QUAD;
1549 break;
1550 default:
1551 dev_warn(&master->dev,
1552 "spi-tx-bus-width %d not supported\n",
1553 value);
1554 break;
1555 }
1556 }
1557
1558 if (!of_property_read_u32(nc, "spi-rx-bus-width", &value)) {
1559 switch (value) {
1560 case 1:
1561 break;
1562 case 2:
1563 spi->mode |= SPI_RX_DUAL;
1564 break;
1565 case 4:
1566 spi->mode |= SPI_RX_QUAD;
1567 break;
1568 default:
1569 dev_warn(&master->dev,
1570 "spi-rx-bus-width %d not supported\n",
1571 value);
1572 break;
1573 }
1574 }
1575
1576 /* Device speed */
1577 rc = of_property_read_u32(nc, "spi-max-frequency", &value);
1578 if (rc) {
1579 dev_err(&master->dev, "%s has no valid 'spi-max-frequency' property (%d)\n",
1580 nc->full_name, rc);
1581 goto err_out;
1582 }
1583 spi->max_speed_hz = value;
1584
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001585 /* Store a pointer to the node in the device structure */
1586 of_node_get(nc);
1587 spi->dev.of_node = nc;
1588
1589 /* Register the new device */
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001590 rc = spi_add_device(spi);
1591 if (rc) {
1592 dev_err(&master->dev, "spi_device register error %s\n",
1593 nc->full_name);
Johan Hovold9846c672017-01-30 17:47:05 +01001594 goto err_of_node_put;
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001595 }
1596
1597 return spi;
1598
Johan Hovold9846c672017-01-30 17:47:05 +01001599err_of_node_put:
1600 of_node_put(nc);
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001601err_out:
1602 spi_dev_put(spi);
1603 return ERR_PTR(rc);
1604}
1605
Grant Likelyd57a4282012-04-07 14:16:53 -06001606/**
1607 * of_register_spi_devices() - Register child devices onto the SPI bus
1608 * @master: Pointer to spi_master device
1609 *
1610 * Registers an spi_device for each child node of master node which has a 'reg'
1611 * property.
1612 */
1613static void of_register_spi_devices(struct spi_master *master)
1614{
1615 struct spi_device *spi;
1616 struct device_node *nc;
Grant Likelyd57a4282012-04-07 14:16:53 -06001617
1618 if (!master->dev.of_node)
1619 return;
1620
Alexander Sverdlinf3b61592012-11-29 08:59:29 +01001621 for_each_available_child_of_node(master->dev.of_node, nc) {
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +01001622 if (of_node_test_and_set_flag(nc, OF_POPULATED))
1623 continue;
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001624 spi = of_register_spi_device(master, nc);
Ralf Ramsauere0af98a2016-10-17 15:59:56 +02001625 if (IS_ERR(spi)) {
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001626 dev_warn(&master->dev, "Failed to create SPI device for %s\n",
Grant Likelyd57a4282012-04-07 14:16:53 -06001627 nc->full_name);
Ralf Ramsauere0af98a2016-10-17 15:59:56 +02001628 of_node_clear_flag(nc, OF_POPULATED);
1629 }
Grant Likelyd57a4282012-04-07 14:16:53 -06001630 }
1631}
1632#else
1633static void of_register_spi_devices(struct spi_master *master) { }
1634#endif
1635
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001636#ifdef CONFIG_ACPI
1637static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
1638{
1639 struct spi_device *spi = data;
Mika Westerberga0a90712016-02-08 17:14:28 +02001640 struct spi_master *master = spi->master;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001641
1642 if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
1643 struct acpi_resource_spi_serialbus *sb;
1644
1645 sb = &ares->data.spi_serial_bus;
1646 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
Mika Westerberga0a90712016-02-08 17:14:28 +02001647 /*
1648 * ACPI DeviceSelection numbering is handled by the
1649 * host controller driver in Windows and can vary
1650 * from driver to driver. In Linux we always expect
1651 * 0 .. max - 1 so we need to ask the driver to
1652 * translate between the two schemes.
1653 */
1654 if (master->fw_translate_cs) {
1655 int cs = master->fw_translate_cs(master,
1656 sb->device_selection);
1657 if (cs < 0)
1658 return cs;
1659 spi->chip_select = cs;
1660 } else {
1661 spi->chip_select = sb->device_selection;
1662 }
1663
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001664 spi->max_speed_hz = sb->connection_speed;
1665
1666 if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
1667 spi->mode |= SPI_CPHA;
1668 if (sb->clock_polarity == ACPI_SPI_START_HIGH)
1669 spi->mode |= SPI_CPOL;
1670 if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
1671 spi->mode |= SPI_CS_HIGH;
1672 }
1673 } else if (spi->irq < 0) {
1674 struct resource r;
1675
1676 if (acpi_dev_resource_interrupt(ares, 0, &r))
1677 spi->irq = r.start;
1678 }
1679
1680 /* Always tell the ACPI core to skip this resource */
1681 return 1;
1682}
1683
Octavian Purdila7f244672016-07-08 19:13:11 +03001684static acpi_status acpi_register_spi_device(struct spi_master *master,
1685 struct acpi_device *adev)
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001686{
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001687 struct list_head resource_list;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001688 struct spi_device *spi;
1689 int ret;
1690
Octavian Purdila7f244672016-07-08 19:13:11 +03001691 if (acpi_bus_get_status(adev) || !adev->status.present ||
1692 acpi_device_enumerated(adev))
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001693 return AE_OK;
1694
1695 spi = spi_alloc_device(master);
1696 if (!spi) {
1697 dev_err(&master->dev, "failed to allocate SPI device for %s\n",
1698 dev_name(&adev->dev));
1699 return AE_NO_MEMORY;
1700 }
1701
Rafael J. Wysocki7b199812013-11-11 22:41:56 +01001702 ACPI_COMPANION_SET(&spi->dev, adev);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001703 spi->irq = -1;
1704
1705 INIT_LIST_HEAD(&resource_list);
1706 ret = acpi_dev_get_resources(adev, &resource_list,
1707 acpi_spi_add_resource, spi);
1708 acpi_dev_free_resource_list(&resource_list);
1709
1710 if (ret < 0 || !spi->max_speed_hz) {
1711 spi_dev_put(spi);
1712 return AE_OK;
1713 }
1714
Christophe RICARD33ada672015-12-23 23:25:35 +01001715 if (spi->irq < 0)
1716 spi->irq = acpi_dev_gpio_irq_get(adev, 0);
1717
Octavian Purdila7f244672016-07-08 19:13:11 +03001718 acpi_device_set_enumerated(adev);
1719
Mika Westerberg33cf00e2013-10-10 13:28:48 +03001720 adev->power.flags.ignore_parent = true;
Jarkko Nikulacf9eb392013-10-10 17:19:17 +03001721 strlcpy(spi->modalias, acpi_device_hid(adev), sizeof(spi->modalias));
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001722 if (spi_add_device(spi)) {
Mika Westerberg33cf00e2013-10-10 13:28:48 +03001723 adev->power.flags.ignore_parent = false;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001724 dev_err(&master->dev, "failed to add SPI device %s from ACPI\n",
1725 dev_name(&adev->dev));
1726 spi_dev_put(spi);
1727 }
1728
1729 return AE_OK;
1730}
1731
Octavian Purdila7f244672016-07-08 19:13:11 +03001732static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
1733 void *data, void **return_value)
1734{
1735 struct spi_master *master = data;
1736 struct acpi_device *adev;
1737
1738 if (acpi_bus_get_device(handle, &adev))
1739 return AE_OK;
1740
1741 return acpi_register_spi_device(master, adev);
1742}
1743
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001744static void acpi_register_spi_devices(struct spi_master *master)
1745{
1746 acpi_status status;
1747 acpi_handle handle;
1748
Rafael J. Wysocki29896172013-04-01 00:21:08 +00001749 handle = ACPI_HANDLE(master->dev.parent);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001750 if (!handle)
1751 return;
1752
1753 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
1754 acpi_spi_add_device, NULL,
1755 master, NULL);
1756 if (ACPI_FAILURE(status))
1757 dev_warn(&master->dev, "failed to enumerate SPI slaves\n");
1758}
1759#else
1760static inline void acpi_register_spi_devices(struct spi_master *master) {}
1761#endif /* CONFIG_ACPI */
1762
Tony Jones49dce682007-10-16 01:27:48 -07001763static void spi_master_release(struct device *dev)
David Brownell8ae12a02006-01-08 13:34:19 -08001764{
1765 struct spi_master *master;
1766
Tony Jones49dce682007-10-16 01:27:48 -07001767 master = container_of(dev, struct spi_master, dev);
David Brownell8ae12a02006-01-08 13:34:19 -08001768 kfree(master);
1769}
1770
1771static struct class spi_master_class = {
1772 .name = "spi_master",
1773 .owner = THIS_MODULE,
Tony Jones49dce682007-10-16 01:27:48 -07001774 .dev_release = spi_master_release,
Martin Sperleca2ebc2015-06-22 13:00:36 +00001775 .dev_groups = spi_master_groups,
David Brownell8ae12a02006-01-08 13:34:19 -08001776};
1777
1778
1779/**
1780 * spi_alloc_master - allocate SPI master controller
1781 * @dev: the controller, possibly using the platform_bus
David Brownell33e34dc2007-05-08 00:32:21 -07001782 * @size: how much zeroed driver-private data to allocate; the pointer to this
Tony Jones49dce682007-10-16 01:27:48 -07001783 * memory is in the driver_data field of the returned device,
David Brownell0c868462006-01-08 13:34:25 -08001784 * accessible with spi_master_get_devdata().
David Brownell33e34dc2007-05-08 00:32:21 -07001785 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001786 *
1787 * This call is used only by SPI master controller drivers, which are the
1788 * only ones directly touching chip registers. It's how they allocate
dmitry pervushinba1a0512006-05-20 15:00:14 -07001789 * an spi_master structure, prior to calling spi_register_master().
David Brownell8ae12a02006-01-08 13:34:19 -08001790 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001791 * This must be called from context that can sleep.
David Brownell8ae12a02006-01-08 13:34:19 -08001792 *
1793 * The caller is responsible for assigning the bus number and initializing
dmitry pervushinba1a0512006-05-20 15:00:14 -07001794 * the master's methods before calling spi_register_master(); and (after errors
Guenter Roecka394d632015-09-06 01:46:54 +03001795 * adding the device) calling spi_master_put() to prevent a memory leak.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001796 *
1797 * Return: the SPI master structure on success, else NULL.
David Brownell8ae12a02006-01-08 13:34:19 -08001798 */
Adrian Bunke9d5a462007-03-26 21:32:23 -08001799struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
David Brownell8ae12a02006-01-08 13:34:19 -08001800{
1801 struct spi_master *master;
1802
David Brownell0c868462006-01-08 13:34:25 -08001803 if (!dev)
1804 return NULL;
1805
Jingoo Han5fe5f052013-10-14 10:31:51 +09001806 master = kzalloc(size + sizeof(*master), GFP_KERNEL);
David Brownell8ae12a02006-01-08 13:34:19 -08001807 if (!master)
1808 return NULL;
1809
Tony Jones49dce682007-10-16 01:27:48 -07001810 device_initialize(&master->dev);
Grant Likely1e8a52e2012-05-19 23:42:08 -06001811 master->bus_num = -1;
1812 master->num_chipselect = 1;
Tony Jones49dce682007-10-16 01:27:48 -07001813 master->dev.class = &spi_master_class;
Johan Hovold157f38f2015-12-14 16:16:19 +01001814 master->dev.parent = dev;
Linus Walleijd7e2ee22016-04-11 13:51:03 +02001815 pm_suspend_ignore_children(&master->dev, true);
David Brownell0c868462006-01-08 13:34:25 -08001816 spi_master_set_devdata(master, &master[1]);
David Brownell8ae12a02006-01-08 13:34:19 -08001817
1818 return master;
1819}
1820EXPORT_SYMBOL_GPL(spi_alloc_master);
1821
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001822#ifdef CONFIG_OF
1823static int of_spi_register_master(struct spi_master *master)
1824{
Grant Likelye80beb22013-02-12 17:48:37 +00001825 int nb, i, *cs;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001826 struct device_node *np = master->dev.of_node;
1827
1828 if (!np)
1829 return 0;
1830
1831 nb = of_gpio_named_count(np, "cs-gpios");
Jingoo Han5fe5f052013-10-14 10:31:51 +09001832 master->num_chipselect = max_t(int, nb, master->num_chipselect);
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001833
Andreas Larsson8ec5d842013-02-13 14:23:24 +01001834 /* Return error only for an incorrectly formed cs-gpios property */
1835 if (nb == 0 || nb == -ENOENT)
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001836 return 0;
Andreas Larsson8ec5d842013-02-13 14:23:24 +01001837 else if (nb < 0)
1838 return nb;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001839
1840 cs = devm_kzalloc(&master->dev,
1841 sizeof(int) * master->num_chipselect,
1842 GFP_KERNEL);
1843 master->cs_gpios = cs;
1844
1845 if (!master->cs_gpios)
1846 return -ENOMEM;
1847
Andreas Larsson0da83bb2013-01-29 15:53:40 +01001848 for (i = 0; i < master->num_chipselect; i++)
Andreas Larsson446411e2013-02-13 14:20:25 +01001849 cs[i] = -ENOENT;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001850
1851 for (i = 0; i < nb; i++)
1852 cs[i] = of_get_named_gpio(np, "cs-gpios", i);
1853
1854 return 0;
1855}
1856#else
1857static int of_spi_register_master(struct spi_master *master)
1858{
1859 return 0;
1860}
1861#endif
1862
David Brownell8ae12a02006-01-08 13:34:19 -08001863/**
1864 * spi_register_master - register SPI master controller
1865 * @master: initialized master, originally from spi_alloc_master()
David Brownell33e34dc2007-05-08 00:32:21 -07001866 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001867 *
1868 * SPI master controllers connect to their drivers using some non-SPI bus,
1869 * such as the platform bus. The final stage of probe() in that code
1870 * includes calling spi_register_master() to hook up to this SPI bus glue.
1871 *
1872 * SPI controllers use board specific (often SOC specific) bus numbers,
1873 * and board-specific addressing for SPI devices combines those numbers
1874 * with chip select numbers. Since SPI does not directly support dynamic
1875 * device identification, boards need configuration tables telling which
1876 * chip is at which address.
1877 *
1878 * This must be called from context that can sleep. It returns zero on
1879 * success, else a negative error code (dropping the master's refcount).
David Brownell0c868462006-01-08 13:34:25 -08001880 * After a successful return, the caller is responsible for calling
1881 * spi_unregister_master().
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001882 *
1883 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08001884 */
Adrian Bunke9d5a462007-03-26 21:32:23 -08001885int spi_register_master(struct spi_master *master)
David Brownell8ae12a02006-01-08 13:34:19 -08001886{
David Brownelle44a45a2007-06-03 13:50:40 -07001887 static atomic_t dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
Tony Jones49dce682007-10-16 01:27:48 -07001888 struct device *dev = master->dev.parent;
Feng Tang2b9603a2010-08-02 15:52:15 +08001889 struct boardinfo *bi;
David Brownell8ae12a02006-01-08 13:34:19 -08001890 int status = -ENODEV;
1891 int dynamic = 0;
1892
David Brownell0c868462006-01-08 13:34:25 -08001893 if (!dev)
1894 return -ENODEV;
1895
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001896 status = of_spi_register_master(master);
1897 if (status)
1898 return status;
1899
David Brownell082c8cb2007-07-31 00:39:45 -07001900 /* even if it's just one always-selected device, there must
1901 * be at least one chipselect
1902 */
1903 if (master->num_chipselect == 0)
1904 return -EINVAL;
1905
Grant Likelybb297852012-12-21 19:32:09 +00001906 if ((master->bus_num < 0) && master->dev.of_node)
1907 master->bus_num = of_alias_get_id(master->dev.of_node, "spi");
1908
David Brownell8ae12a02006-01-08 13:34:19 -08001909 /* convention: dynamically assigned bus IDs count down from the max */
David Brownella020ed72006-04-03 15:49:04 -07001910 if (master->bus_num < 0) {
David Brownell082c8cb2007-07-31 00:39:45 -07001911 /* FIXME switch to an IDR based scheme, something like
1912 * I2C now uses, so we can't run out of "dynamic" IDs
1913 */
David Brownell8ae12a02006-01-08 13:34:19 -08001914 master->bus_num = atomic_dec_return(&dyn_bus_id);
David Brownellb8852442006-01-08 13:34:23 -08001915 dynamic = 1;
David Brownell8ae12a02006-01-08 13:34:19 -08001916 }
1917
Mark Brown5424d432014-12-10 17:40:53 +00001918 INIT_LIST_HEAD(&master->queue);
1919 spin_lock_init(&master->queue_lock);
Ernst Schwabcf32b712010-06-28 17:49:29 -07001920 spin_lock_init(&master->bus_lock_spinlock);
1921 mutex_init(&master->bus_lock_mutex);
Mark Brownef4d96e2016-07-21 23:53:31 +01001922 mutex_init(&master->io_mutex);
Ernst Schwabcf32b712010-06-28 17:49:29 -07001923 master->bus_lock_flag = 0;
Mark Brownb1589352013-10-05 11:50:40 +01001924 init_completion(&master->xfer_completion);
Mark Brown6ad45a22014-02-02 13:47:47 +00001925 if (!master->max_dma_len)
1926 master->max_dma_len = INT_MAX;
Ernst Schwabcf32b712010-06-28 17:49:29 -07001927
David Brownell8ae12a02006-01-08 13:34:19 -08001928 /* register the device, then userspace will see it.
1929 * registration fails if the bus ID is in use.
1930 */
Kay Sievers35f74fc2009-01-06 10:44:37 -08001931 dev_set_name(&master->dev, "spi%u", master->bus_num);
Tony Jones49dce682007-10-16 01:27:48 -07001932 status = device_add(&master->dev);
David Brownellb8852442006-01-08 13:34:23 -08001933 if (status < 0)
David Brownell8ae12a02006-01-08 13:34:19 -08001934 goto done;
Kay Sievers35f74fc2009-01-06 10:44:37 -08001935 dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
David Brownell8ae12a02006-01-08 13:34:19 -08001936 dynamic ? " (dynamic)" : "");
1937
Linus Walleijffbbdd212012-02-22 10:05:38 +01001938 /* If we're using a queued driver, start the queue */
1939 if (master->transfer)
1940 dev_info(dev, "master is unqueued, this is deprecated\n");
1941 else {
1942 status = spi_master_initialize_queue(master);
1943 if (status) {
Axel Line93b0722013-08-31 20:25:52 +08001944 device_del(&master->dev);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001945 goto done;
1946 }
1947 }
Martin Sperleca2ebc2015-06-22 13:00:36 +00001948 /* add statistics */
1949 spin_lock_init(&master->statistics.lock);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001950
Feng Tang2b9603a2010-08-02 15:52:15 +08001951 mutex_lock(&board_lock);
1952 list_add_tail(&master->list, &spi_master_list);
1953 list_for_each_entry(bi, &board_list, list)
1954 spi_match_master_to_boardinfo(master, &bi->board_info);
1955 mutex_unlock(&board_lock);
1956
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001957 /* Register devices from the device tree and ACPI */
Anatolij Gustschin12b15e82010-07-27 22:35:58 +02001958 of_register_spi_devices(master);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001959 acpi_register_spi_devices(master);
David Brownell8ae12a02006-01-08 13:34:19 -08001960done:
1961 return status;
1962}
1963EXPORT_SYMBOL_GPL(spi_register_master);
1964
Mark Brown666d5b42013-08-31 18:50:52 +01001965static void devm_spi_unregister(struct device *dev, void *res)
1966{
1967 spi_unregister_master(*(struct spi_master **)res);
1968}
1969
1970/**
1971 * dev_spi_register_master - register managed SPI master controller
1972 * @dev: device managing SPI master
1973 * @master: initialized master, originally from spi_alloc_master()
1974 * Context: can sleep
1975 *
1976 * Register a SPI device as with spi_register_master() which will
1977 * automatically be unregister
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001978 *
1979 * Return: zero on success, else a negative error code.
Mark Brown666d5b42013-08-31 18:50:52 +01001980 */
1981int devm_spi_register_master(struct device *dev, struct spi_master *master)
1982{
1983 struct spi_master **ptr;
1984 int ret;
1985
1986 ptr = devres_alloc(devm_spi_unregister, sizeof(*ptr), GFP_KERNEL);
1987 if (!ptr)
1988 return -ENOMEM;
1989
1990 ret = spi_register_master(master);
Stephen Warren4b928942013-11-21 16:11:15 -07001991 if (!ret) {
Mark Brown666d5b42013-08-31 18:50:52 +01001992 *ptr = master;
1993 devres_add(dev, ptr);
1994 } else {
1995 devres_free(ptr);
1996 }
1997
1998 return ret;
1999}
2000EXPORT_SYMBOL_GPL(devm_spi_register_master);
2001
David Lamparter34860082010-08-30 23:54:17 +02002002static int __unregister(struct device *dev, void *null)
David Brownell8ae12a02006-01-08 13:34:19 -08002003{
David Lamparter34860082010-08-30 23:54:17 +02002004 spi_unregister_device(to_spi_device(dev));
David Brownell8ae12a02006-01-08 13:34:19 -08002005 return 0;
2006}
2007
2008/**
2009 * spi_unregister_master - unregister SPI master controller
2010 * @master: the master being unregistered
David Brownell33e34dc2007-05-08 00:32:21 -07002011 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08002012 *
2013 * This call is used only by SPI master controller drivers, which are the
2014 * only ones directly touching chip registers.
2015 *
2016 * This must be called from context that can sleep.
2017 */
2018void spi_unregister_master(struct spi_master *master)
2019{
Jeff Garzik89fc9a12006-12-06 20:35:35 -08002020 int dummy;
2021
Linus Walleijffbbdd212012-02-22 10:05:38 +01002022 if (master->queued) {
2023 if (spi_destroy_queue(master))
2024 dev_err(&master->dev, "queue remove failed\n");
2025 }
2026
Feng Tang2b9603a2010-08-02 15:52:15 +08002027 mutex_lock(&board_lock);
2028 list_del(&master->list);
2029 mutex_unlock(&board_lock);
2030
Sebastian Andrzej Siewior97dbf372010-12-21 17:24:31 -08002031 dummy = device_for_each_child(&master->dev, NULL, __unregister);
Tony Jones49dce682007-10-16 01:27:48 -07002032 device_unregister(&master->dev);
David Brownell8ae12a02006-01-08 13:34:19 -08002033}
2034EXPORT_SYMBOL_GPL(spi_unregister_master);
2035
Linus Walleijffbbdd212012-02-22 10:05:38 +01002036int spi_master_suspend(struct spi_master *master)
2037{
2038 int ret;
2039
2040 /* Basically no-ops for non-queued masters */
2041 if (!master->queued)
2042 return 0;
2043
2044 ret = spi_stop_queue(master);
2045 if (ret)
2046 dev_err(&master->dev, "queue stop failed\n");
2047
2048 return ret;
2049}
2050EXPORT_SYMBOL_GPL(spi_master_suspend);
2051
2052int spi_master_resume(struct spi_master *master)
2053{
2054 int ret;
2055
2056 if (!master->queued)
2057 return 0;
2058
2059 ret = spi_start_queue(master);
2060 if (ret)
2061 dev_err(&master->dev, "queue restart failed\n");
2062
2063 return ret;
2064}
2065EXPORT_SYMBOL_GPL(spi_master_resume);
2066
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002067static int __spi_master_match(struct device *dev, const void *data)
Dave Young5ed2c832008-01-22 15:14:18 +08002068{
2069 struct spi_master *m;
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002070 const u16 *bus_num = data;
Dave Young5ed2c832008-01-22 15:14:18 +08002071
2072 m = container_of(dev, struct spi_master, dev);
2073 return m->bus_num == *bus_num;
2074}
2075
David Brownell8ae12a02006-01-08 13:34:19 -08002076/**
2077 * spi_busnum_to_master - look up master associated with bus_num
2078 * @bus_num: the master's bus number
David Brownell33e34dc2007-05-08 00:32:21 -07002079 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08002080 *
2081 * This call may be used with devices that are registered after
2082 * arch init time. It returns a refcounted pointer to the relevant
2083 * spi_master (which the caller must release), or NULL if there is
2084 * no such master registered.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002085 *
2086 * Return: the SPI master structure on success, else NULL.
David Brownell8ae12a02006-01-08 13:34:19 -08002087 */
2088struct spi_master *spi_busnum_to_master(u16 bus_num)
2089{
Tony Jones49dce682007-10-16 01:27:48 -07002090 struct device *dev;
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -08002091 struct spi_master *master = NULL;
David Brownell8ae12a02006-01-08 13:34:19 -08002092
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04002093 dev = class_find_device(&spi_master_class, NULL, &bus_num,
Dave Young5ed2c832008-01-22 15:14:18 +08002094 __spi_master_match);
2095 if (dev)
2096 master = container_of(dev, struct spi_master, dev);
2097 /* reference got in class_find_device */
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -08002098 return master;
David Brownell8ae12a02006-01-08 13:34:19 -08002099}
2100EXPORT_SYMBOL_GPL(spi_busnum_to_master);
2101
Martin Sperld780c372015-12-14 15:20:18 +00002102/*-------------------------------------------------------------------------*/
2103
2104/* Core methods for SPI resource management */
2105
2106/**
2107 * spi_res_alloc - allocate a spi resource that is life-cycle managed
2108 * during the processing of a spi_message while using
2109 * spi_transfer_one
2110 * @spi: the spi device for which we allocate memory
2111 * @release: the release code to execute for this resource
2112 * @size: size to alloc and return
2113 * @gfp: GFP allocation flags
2114 *
2115 * Return: the pointer to the allocated data
2116 *
2117 * This may get enhanced in the future to allocate from a memory pool
2118 * of the @spi_device or @spi_master to avoid repeated allocations.
2119 */
2120void *spi_res_alloc(struct spi_device *spi,
2121 spi_res_release_t release,
2122 size_t size, gfp_t gfp)
2123{
2124 struct spi_res *sres;
2125
2126 sres = kzalloc(sizeof(*sres) + size, gfp);
2127 if (!sres)
2128 return NULL;
2129
2130 INIT_LIST_HEAD(&sres->entry);
2131 sres->release = release;
2132
2133 return sres->data;
2134}
2135EXPORT_SYMBOL_GPL(spi_res_alloc);
2136
2137/**
2138 * spi_res_free - free an spi resource
2139 * @res: pointer to the custom data of a resource
2140 *
2141 */
2142void spi_res_free(void *res)
2143{
2144 struct spi_res *sres = container_of(res, struct spi_res, data);
2145
2146 if (!res)
2147 return;
2148
2149 WARN_ON(!list_empty(&sres->entry));
2150 kfree(sres);
2151}
2152EXPORT_SYMBOL_GPL(spi_res_free);
2153
2154/**
2155 * spi_res_add - add a spi_res to the spi_message
2156 * @message: the spi message
2157 * @res: the spi_resource
2158 */
2159void spi_res_add(struct spi_message *message, void *res)
2160{
2161 struct spi_res *sres = container_of(res, struct spi_res, data);
2162
2163 WARN_ON(!list_empty(&sres->entry));
2164 list_add_tail(&sres->entry, &message->resources);
2165}
2166EXPORT_SYMBOL_GPL(spi_res_add);
2167
2168/**
2169 * spi_res_release - release all spi resources for this message
2170 * @master: the @spi_master
2171 * @message: the @spi_message
2172 */
2173void spi_res_release(struct spi_master *master,
2174 struct spi_message *message)
2175{
2176 struct spi_res *res;
2177
2178 while (!list_empty(&message->resources)) {
2179 res = list_last_entry(&message->resources,
2180 struct spi_res, entry);
2181
2182 if (res->release)
2183 res->release(master, message, res->data);
2184
2185 list_del(&res->entry);
2186
2187 kfree(res);
2188 }
2189}
2190EXPORT_SYMBOL_GPL(spi_res_release);
David Brownell8ae12a02006-01-08 13:34:19 -08002191
2192/*-------------------------------------------------------------------------*/
2193
Martin Sperl523baf5a2015-12-14 15:20:19 +00002194/* Core methods for spi_message alterations */
2195
2196static void __spi_replace_transfers_release(struct spi_master *master,
2197 struct spi_message *msg,
2198 void *res)
2199{
2200 struct spi_replaced_transfers *rxfer = res;
2201 size_t i;
2202
2203 /* call extra callback if requested */
2204 if (rxfer->release)
2205 rxfer->release(master, msg, res);
2206
2207 /* insert replaced transfers back into the message */
2208 list_splice(&rxfer->replaced_transfers, rxfer->replaced_after);
2209
2210 /* remove the formerly inserted entries */
2211 for (i = 0; i < rxfer->inserted; i++)
2212 list_del(&rxfer->inserted_transfers[i].transfer_list);
2213}
2214
2215/**
2216 * spi_replace_transfers - replace transfers with several transfers
2217 * and register change with spi_message.resources
2218 * @msg: the spi_message we work upon
2219 * @xfer_first: the first spi_transfer we want to replace
2220 * @remove: number of transfers to remove
2221 * @insert: the number of transfers we want to insert instead
2222 * @release: extra release code necessary in some circumstances
2223 * @extradatasize: extra data to allocate (with alignment guarantees
2224 * of struct @spi_transfer)
Martin Sperl05885392016-02-18 15:53:11 +00002225 * @gfp: gfp flags
Martin Sperl523baf5a2015-12-14 15:20:19 +00002226 *
2227 * Returns: pointer to @spi_replaced_transfers,
2228 * PTR_ERR(...) in case of errors.
2229 */
2230struct spi_replaced_transfers *spi_replace_transfers(
2231 struct spi_message *msg,
2232 struct spi_transfer *xfer_first,
2233 size_t remove,
2234 size_t insert,
2235 spi_replaced_release_t release,
2236 size_t extradatasize,
2237 gfp_t gfp)
2238{
2239 struct spi_replaced_transfers *rxfer;
2240 struct spi_transfer *xfer;
2241 size_t i;
2242
2243 /* allocate the structure using spi_res */
2244 rxfer = spi_res_alloc(msg->spi, __spi_replace_transfers_release,
2245 insert * sizeof(struct spi_transfer)
2246 + sizeof(struct spi_replaced_transfers)
2247 + extradatasize,
2248 gfp);
2249 if (!rxfer)
2250 return ERR_PTR(-ENOMEM);
2251
2252 /* the release code to invoke before running the generic release */
2253 rxfer->release = release;
2254
2255 /* assign extradata */
2256 if (extradatasize)
2257 rxfer->extradata =
2258 &rxfer->inserted_transfers[insert];
2259
2260 /* init the replaced_transfers list */
2261 INIT_LIST_HEAD(&rxfer->replaced_transfers);
2262
2263 /* assign the list_entry after which we should reinsert
2264 * the @replaced_transfers - it may be spi_message.messages!
2265 */
2266 rxfer->replaced_after = xfer_first->transfer_list.prev;
2267
2268 /* remove the requested number of transfers */
2269 for (i = 0; i < remove; i++) {
2270 /* if the entry after replaced_after it is msg->transfers
2271 * then we have been requested to remove more transfers
2272 * than are in the list
2273 */
2274 if (rxfer->replaced_after->next == &msg->transfers) {
2275 dev_err(&msg->spi->dev,
2276 "requested to remove more spi_transfers than are available\n");
2277 /* insert replaced transfers back into the message */
2278 list_splice(&rxfer->replaced_transfers,
2279 rxfer->replaced_after);
2280
2281 /* free the spi_replace_transfer structure */
2282 spi_res_free(rxfer);
2283
2284 /* and return with an error */
2285 return ERR_PTR(-EINVAL);
2286 }
2287
2288 /* remove the entry after replaced_after from list of
2289 * transfers and add it to list of replaced_transfers
2290 */
2291 list_move_tail(rxfer->replaced_after->next,
2292 &rxfer->replaced_transfers);
2293 }
2294
2295 /* create copy of the given xfer with identical settings
2296 * based on the first transfer to get removed
2297 */
2298 for (i = 0; i < insert; i++) {
2299 /* we need to run in reverse order */
2300 xfer = &rxfer->inserted_transfers[insert - 1 - i];
2301
2302 /* copy all spi_transfer data */
2303 memcpy(xfer, xfer_first, sizeof(*xfer));
2304
2305 /* add to list */
2306 list_add(&xfer->transfer_list, rxfer->replaced_after);
2307
2308 /* clear cs_change and delay_usecs for all but the last */
2309 if (i) {
2310 xfer->cs_change = false;
2311 xfer->delay_usecs = 0;
2312 }
2313 }
2314
2315 /* set up inserted */
2316 rxfer->inserted = insert;
2317
2318 /* and register it with spi_res/spi_message */
2319 spi_res_add(msg, rxfer);
2320
2321 return rxfer;
2322}
2323EXPORT_SYMBOL_GPL(spi_replace_transfers);
2324
Fabio Estevam08933412016-02-14 13:33:50 -02002325static int __spi_split_transfer_maxsize(struct spi_master *master,
2326 struct spi_message *msg,
2327 struct spi_transfer **xferp,
2328 size_t maxsize,
2329 gfp_t gfp)
Martin Sperld9f12122015-12-14 15:20:20 +00002330{
2331 struct spi_transfer *xfer = *xferp, *xfers;
2332 struct spi_replaced_transfers *srt;
2333 size_t offset;
2334 size_t count, i;
2335
2336 /* warn once about this fact that we are splitting a transfer */
2337 dev_warn_once(&msg->spi->dev,
Fabio Estevam7d62f512016-02-17 15:42:27 -02002338 "spi_transfer of length %i exceed max length of %zu - needed to split transfers\n",
Martin Sperld9f12122015-12-14 15:20:20 +00002339 xfer->len, maxsize);
2340
2341 /* calculate how many we have to replace */
2342 count = DIV_ROUND_UP(xfer->len, maxsize);
2343
2344 /* create replacement */
2345 srt = spi_replace_transfers(msg, xfer, 1, count, NULL, 0, gfp);
Dan Carpenter657d32e2016-02-12 09:38:33 +03002346 if (IS_ERR(srt))
2347 return PTR_ERR(srt);
Martin Sperld9f12122015-12-14 15:20:20 +00002348 xfers = srt->inserted_transfers;
2349
2350 /* now handle each of those newly inserted spi_transfers
2351 * note that the replacements spi_transfers all are preset
2352 * to the same values as *xferp, so tx_buf, rx_buf and len
2353 * are all identical (as well as most others)
2354 * so we just have to fix up len and the pointers.
2355 *
2356 * this also includes support for the depreciated
2357 * spi_message.is_dma_mapped interface
2358 */
2359
2360 /* the first transfer just needs the length modified, so we
2361 * run it outside the loop
2362 */
Fabio Estevamc8dab772016-02-17 15:42:28 -02002363 xfers[0].len = min_t(size_t, maxsize, xfer[0].len);
Martin Sperld9f12122015-12-14 15:20:20 +00002364
2365 /* all the others need rx_buf/tx_buf also set */
2366 for (i = 1, offset = maxsize; i < count; offset += maxsize, i++) {
2367 /* update rx_buf, tx_buf and dma */
2368 if (xfers[i].rx_buf)
2369 xfers[i].rx_buf += offset;
2370 if (xfers[i].rx_dma)
2371 xfers[i].rx_dma += offset;
2372 if (xfers[i].tx_buf)
2373 xfers[i].tx_buf += offset;
2374 if (xfers[i].tx_dma)
2375 xfers[i].tx_dma += offset;
2376
2377 /* update length */
2378 xfers[i].len = min(maxsize, xfers[i].len - offset);
2379 }
2380
2381 /* we set up xferp to the last entry we have inserted,
2382 * so that we skip those already split transfers
2383 */
2384 *xferp = &xfers[count - 1];
2385
2386 /* increment statistics counters */
2387 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics,
2388 transfers_split_maxsize);
2389 SPI_STATISTICS_INCREMENT_FIELD(&msg->spi->statistics,
2390 transfers_split_maxsize);
2391
2392 return 0;
2393}
2394
2395/**
2396 * spi_split_tranfers_maxsize - split spi transfers into multiple transfers
2397 * when an individual transfer exceeds a
2398 * certain size
2399 * @master: the @spi_master for this transfer
Masanari Iida3700ce92016-02-22 20:33:44 +09002400 * @msg: the @spi_message to transform
2401 * @maxsize: the maximum when to apply this
Javier Martinez Canillas10f11a22016-03-10 15:01:14 -03002402 * @gfp: GFP allocation flags
Martin Sperld9f12122015-12-14 15:20:20 +00002403 *
2404 * Return: status of transformation
2405 */
2406int spi_split_transfers_maxsize(struct spi_master *master,
2407 struct spi_message *msg,
2408 size_t maxsize,
2409 gfp_t gfp)
2410{
2411 struct spi_transfer *xfer;
2412 int ret;
2413
2414 /* iterate over the transfer_list,
2415 * but note that xfer is advanced to the last transfer inserted
2416 * to avoid checking sizes again unnecessarily (also xfer does
2417 * potentiall belong to a different list by the time the
2418 * replacement has happened
2419 */
2420 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
2421 if (xfer->len > maxsize) {
2422 ret = __spi_split_transfer_maxsize(
2423 master, msg, &xfer, maxsize, gfp);
2424 if (ret)
2425 return ret;
2426 }
2427 }
2428
2429 return 0;
2430}
2431EXPORT_SYMBOL_GPL(spi_split_transfers_maxsize);
David Brownell8ae12a02006-01-08 13:34:19 -08002432
2433/*-------------------------------------------------------------------------*/
2434
David Brownell7d077192009-06-17 16:26:03 -07002435/* Core methods for SPI master protocol drivers. Some of the
2436 * other core methods are currently defined as inline functions.
2437 */
2438
Stefan Brüns63ab6452015-08-23 16:06:30 +02002439static int __spi_validate_bits_per_word(struct spi_master *master, u8 bits_per_word)
2440{
2441 if (master->bits_per_word_mask) {
2442 /* Only 32 bits fit in the mask */
2443 if (bits_per_word > 32)
2444 return -EINVAL;
2445 if (!(master->bits_per_word_mask &
2446 SPI_BPW_MASK(bits_per_word)))
2447 return -EINVAL;
2448 }
2449
2450 return 0;
2451}
2452
David Brownell7d077192009-06-17 16:26:03 -07002453/**
2454 * spi_setup - setup SPI mode and clock rate
2455 * @spi: the device whose settings are being modified
2456 * Context: can sleep, and no requests are queued to the device
2457 *
2458 * SPI protocol drivers may need to update the transfer mode if the
2459 * device doesn't work with its default. They may likewise need
2460 * to update clock rates or word sizes from initial values. This function
2461 * changes those settings, and must be called from a context that can sleep.
2462 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
2463 * effect the next time the device is selected and data is transferred to
2464 * or from it. When this function returns, the spi device is deselected.
2465 *
2466 * Note that this call will fail if the protocol driver specifies an option
2467 * that the underlying controller or its driver does not support. For
2468 * example, not all hardware supports wire transfers using nine bit words,
2469 * LSB-first wire encoding, or active-high chipselects.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002470 *
2471 * Return: zero on success, else a negative error code.
David Brownell7d077192009-06-17 16:26:03 -07002472 */
2473int spi_setup(struct spi_device *spi)
2474{
Geert Uytterhoeven83596fb2014-04-14 19:39:53 +02002475 unsigned bad_bits, ugly_bits;
Andy Shevchenko5ab8d262015-10-14 22:43:07 +03002476 int status;
David Brownell7d077192009-06-17 16:26:03 -07002477
wangyuhangf477b7f2013-08-11 18:15:17 +08002478 /* check mode to prevent that DUAL and QUAD set at the same time
2479 */
2480 if (((spi->mode & SPI_TX_DUAL) && (spi->mode & SPI_TX_QUAD)) ||
2481 ((spi->mode & SPI_RX_DUAL) && (spi->mode & SPI_RX_QUAD))) {
2482 dev_err(&spi->dev,
2483 "setup: can not select dual and quad at the same time\n");
2484 return -EINVAL;
2485 }
2486 /* if it is SPI_3WIRE mode, DUAL and QUAD should be forbidden
2487 */
2488 if ((spi->mode & SPI_3WIRE) && (spi->mode &
2489 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD)))
2490 return -EINVAL;
David Brownelle7db06b2009-06-17 16:26:04 -07002491 /* help drivers fail *cleanly* when they need options
2492 * that aren't supported with their current master
2493 */
2494 bad_bits = spi->mode & ~spi->master->mode_bits;
Geert Uytterhoeven83596fb2014-04-14 19:39:53 +02002495 ugly_bits = bad_bits &
2496 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD);
2497 if (ugly_bits) {
2498 dev_warn(&spi->dev,
2499 "setup: ignoring unsupported mode bits %x\n",
2500 ugly_bits);
2501 spi->mode &= ~ugly_bits;
2502 bad_bits &= ~ugly_bits;
2503 }
David Brownelle7db06b2009-06-17 16:26:04 -07002504 if (bad_bits) {
Linus Walleijeb288a12010-10-21 21:06:44 +02002505 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
David Brownelle7db06b2009-06-17 16:26:04 -07002506 bad_bits);
2507 return -EINVAL;
2508 }
2509
David Brownell7d077192009-06-17 16:26:03 -07002510 if (!spi->bits_per_word)
2511 spi->bits_per_word = 8;
2512
Andy Shevchenko5ab8d262015-10-14 22:43:07 +03002513 status = __spi_validate_bits_per_word(spi->master, spi->bits_per_word);
2514 if (status)
2515 return status;
Stefan Brüns63ab6452015-08-23 16:06:30 +02002516
Axel Lin052eb2d42014-02-10 00:08:05 +08002517 if (!spi->max_speed_hz)
2518 spi->max_speed_hz = spi->master->max_speed_hz;
2519
Laxman Dewangancaae0702012-11-09 14:35:22 +05302520 if (spi->master->setup)
2521 status = spi->master->setup(spi);
David Brownell7d077192009-06-17 16:26:03 -07002522
Franklin S Cooper Jrabeedb02015-10-16 10:29:03 -05002523 spi_set_cs(spi, false);
2524
Jingoo Han5fe5f052013-10-14 10:31:51 +09002525 dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s%u bits/w, %u Hz max --> %d\n",
David Brownell7d077192009-06-17 16:26:03 -07002526 (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
2527 (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
2528 (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
2529 (spi->mode & SPI_3WIRE) ? "3wire, " : "",
2530 (spi->mode & SPI_LOOP) ? "loopback, " : "",
2531 spi->bits_per_word, spi->max_speed_hz,
2532 status);
2533
2534 return status;
2535}
2536EXPORT_SYMBOL_GPL(spi_setup);
2537
Mark Brown90808732013-11-13 23:44:15 +00002538static int __spi_validate(struct spi_device *spi, struct spi_message *message)
Ernst Schwabcf32b712010-06-28 17:49:29 -07002539{
2540 struct spi_master *master = spi->master;
Laxman Dewangane6811d12012-11-09 14:36:45 +05302541 struct spi_transfer *xfer;
Atsushi Nemoto6ea31292014-02-28 23:03:16 +09002542 int w_size;
Ernst Schwabcf32b712010-06-28 17:49:29 -07002543
Mark Brown24a00132013-07-10 15:05:40 +01002544 if (list_empty(&message->transfers))
2545 return -EINVAL;
Mark Brown24a00132013-07-10 15:05:40 +01002546
Ernst Schwabcf32b712010-06-28 17:49:29 -07002547 /* Half-duplex links include original MicroWire, and ones with
2548 * only one data pin like SPI_3WIRE (switches direction) or where
2549 * either MOSI or MISO is missing. They can also be caused by
2550 * software limitations.
2551 */
2552 if ((master->flags & SPI_MASTER_HALF_DUPLEX)
2553 || (spi->mode & SPI_3WIRE)) {
Ernst Schwabcf32b712010-06-28 17:49:29 -07002554 unsigned flags = master->flags;
2555
2556 list_for_each_entry(xfer, &message->transfers, transfer_list) {
2557 if (xfer->rx_buf && xfer->tx_buf)
2558 return -EINVAL;
2559 if ((flags & SPI_MASTER_NO_TX) && xfer->tx_buf)
2560 return -EINVAL;
2561 if ((flags & SPI_MASTER_NO_RX) && xfer->rx_buf)
2562 return -EINVAL;
2563 }
2564 }
2565
Laxman Dewangane6811d12012-11-09 14:36:45 +05302566 /**
Laxman Dewangan059b8ff2013-01-05 00:17:14 +05302567 * Set transfer bits_per_word and max speed as spi device default if
2568 * it is not set for this transfer.
wangyuhangf477b7f2013-08-11 18:15:17 +08002569 * Set transfer tx_nbits and rx_nbits as single transfer default
2570 * (SPI_NBITS_SINGLE) if it is not set for this transfer.
Laxman Dewangane6811d12012-11-09 14:36:45 +05302571 */
Martin Sperl77e80582015-11-27 12:31:09 +00002572 message->frame_length = 0;
Laxman Dewangane6811d12012-11-09 14:36:45 +05302573 list_for_each_entry(xfer, &message->transfers, transfer_list) {
Sourav Poddar078726c2013-07-18 15:31:25 +05302574 message->frame_length += xfer->len;
Laxman Dewangane6811d12012-11-09 14:36:45 +05302575 if (!xfer->bits_per_word)
2576 xfer->bits_per_word = spi->bits_per_word;
Axel Lina6f87fa2014-03-17 10:08:12 +08002577
2578 if (!xfer->speed_hz)
Laxman Dewangan059b8ff2013-01-05 00:17:14 +05302579 xfer->speed_hz = spi->max_speed_hz;
Mark Brown7dc9fbc2015-08-20 11:52:18 -07002580 if (!xfer->speed_hz)
2581 xfer->speed_hz = master->max_speed_hz;
Axel Lina6f87fa2014-03-17 10:08:12 +08002582
2583 if (master->max_speed_hz &&
2584 xfer->speed_hz > master->max_speed_hz)
2585 xfer->speed_hz = master->max_speed_hz;
Gabor Juhos56ede942013-08-14 10:25:28 +02002586
Stefan Brüns63ab6452015-08-23 16:06:30 +02002587 if (__spi_validate_bits_per_word(master, xfer->bits_per_word))
2588 return -EINVAL;
Mark Browna2fd4f92013-07-10 14:57:26 +01002589
Ivan T. Ivanov4d94bd22014-02-20 12:02:08 +02002590 /*
2591 * SPI transfer length should be multiple of SPI word size
2592 * where SPI word size should be power-of-two multiple
2593 */
2594 if (xfer->bits_per_word <= 8)
2595 w_size = 1;
2596 else if (xfer->bits_per_word <= 16)
2597 w_size = 2;
2598 else
2599 w_size = 4;
2600
Ivan T. Ivanov4d94bd22014-02-20 12:02:08 +02002601 /* No partial transfers accepted */
Atsushi Nemoto6ea31292014-02-28 23:03:16 +09002602 if (xfer->len % w_size)
Ivan T. Ivanov4d94bd22014-02-20 12:02:08 +02002603 return -EINVAL;
2604
Mark Browna2fd4f92013-07-10 14:57:26 +01002605 if (xfer->speed_hz && master->min_speed_hz &&
2606 xfer->speed_hz < master->min_speed_hz)
2607 return -EINVAL;
wangyuhangf477b7f2013-08-11 18:15:17 +08002608
2609 if (xfer->tx_buf && !xfer->tx_nbits)
2610 xfer->tx_nbits = SPI_NBITS_SINGLE;
2611 if (xfer->rx_buf && !xfer->rx_nbits)
2612 xfer->rx_nbits = SPI_NBITS_SINGLE;
2613 /* check transfer tx/rx_nbits:
Geert Uytterhoeven1afd9982014-01-12 14:00:29 +01002614 * 1. check the value matches one of single, dual and quad
2615 * 2. check tx/rx_nbits match the mode in spi_device
wangyuhangf477b7f2013-08-11 18:15:17 +08002616 */
Sourav Poddardb90a442013-08-22 21:20:48 +05302617 if (xfer->tx_buf) {
2618 if (xfer->tx_nbits != SPI_NBITS_SINGLE &&
2619 xfer->tx_nbits != SPI_NBITS_DUAL &&
2620 xfer->tx_nbits != SPI_NBITS_QUAD)
2621 return -EINVAL;
2622 if ((xfer->tx_nbits == SPI_NBITS_DUAL) &&
2623 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
2624 return -EINVAL;
2625 if ((xfer->tx_nbits == SPI_NBITS_QUAD) &&
2626 !(spi->mode & SPI_TX_QUAD))
2627 return -EINVAL;
Sourav Poddardb90a442013-08-22 21:20:48 +05302628 }
wangyuhangf477b7f2013-08-11 18:15:17 +08002629 /* check transfer rx_nbits */
Sourav Poddardb90a442013-08-22 21:20:48 +05302630 if (xfer->rx_buf) {
2631 if (xfer->rx_nbits != SPI_NBITS_SINGLE &&
2632 xfer->rx_nbits != SPI_NBITS_DUAL &&
2633 xfer->rx_nbits != SPI_NBITS_QUAD)
2634 return -EINVAL;
2635 if ((xfer->rx_nbits == SPI_NBITS_DUAL) &&
2636 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
2637 return -EINVAL;
2638 if ((xfer->rx_nbits == SPI_NBITS_QUAD) &&
2639 !(spi->mode & SPI_RX_QUAD))
2640 return -EINVAL;
Sourav Poddardb90a442013-08-22 21:20:48 +05302641 }
Laxman Dewangane6811d12012-11-09 14:36:45 +05302642 }
2643
Ernst Schwabcf32b712010-06-28 17:49:29 -07002644 message->status = -EINPROGRESS;
Mark Brown90808732013-11-13 23:44:15 +00002645
2646 return 0;
2647}
2648
2649static int __spi_async(struct spi_device *spi, struct spi_message *message)
2650{
2651 struct spi_master *master = spi->master;
2652
2653 message->spi = spi;
2654
Martin Sperleca2ebc2015-06-22 13:00:36 +00002655 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics, spi_async);
2656 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_async);
2657
Mark Brown90808732013-11-13 23:44:15 +00002658 trace_spi_message_submit(message);
2659
Ernst Schwabcf32b712010-06-28 17:49:29 -07002660 return master->transfer(spi, message);
2661}
2662
David Brownell568d0692009-09-22 16:46:18 -07002663/**
2664 * spi_async - asynchronous SPI transfer
2665 * @spi: device with which data will be exchanged
2666 * @message: describes the data transfers, including completion callback
2667 * Context: any (irqs may be blocked, etc)
2668 *
2669 * This call may be used in_irq and other contexts which can't sleep,
2670 * as well as from task contexts which can sleep.
2671 *
2672 * The completion callback is invoked in a context which can't sleep.
2673 * Before that invocation, the value of message->status is undefined.
2674 * When the callback is issued, message->status holds either zero (to
2675 * indicate complete success) or a negative error code. After that
2676 * callback returns, the driver which issued the transfer request may
2677 * deallocate the associated memory; it's no longer in use by any SPI
2678 * core or controller driver code.
2679 *
2680 * Note that although all messages to a spi_device are handled in
2681 * FIFO order, messages may go to different devices in other orders.
2682 * Some device might be higher priority, or have various "hard" access
2683 * time requirements, for example.
2684 *
2685 * On detection of any fault during the transfer, processing of
2686 * the entire message is aborted, and the device is deselected.
2687 * Until returning from the associated message completion callback,
2688 * no other spi_message queued to that device will be processed.
2689 * (This rule applies equally to all the synchronous transfer calls,
2690 * which are wrappers around this core asynchronous primitive.)
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002691 *
2692 * Return: zero on success, else a negative error code.
David Brownell568d0692009-09-22 16:46:18 -07002693 */
2694int spi_async(struct spi_device *spi, struct spi_message *message)
2695{
2696 struct spi_master *master = spi->master;
Ernst Schwabcf32b712010-06-28 17:49:29 -07002697 int ret;
2698 unsigned long flags;
David Brownell568d0692009-09-22 16:46:18 -07002699
Mark Brown90808732013-11-13 23:44:15 +00002700 ret = __spi_validate(spi, message);
2701 if (ret != 0)
2702 return ret;
2703
Ernst Schwabcf32b712010-06-28 17:49:29 -07002704 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
David Brownell568d0692009-09-22 16:46:18 -07002705
Ernst Schwabcf32b712010-06-28 17:49:29 -07002706 if (master->bus_lock_flag)
2707 ret = -EBUSY;
2708 else
2709 ret = __spi_async(spi, message);
David Brownell568d0692009-09-22 16:46:18 -07002710
Ernst Schwabcf32b712010-06-28 17:49:29 -07002711 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2712
2713 return ret;
David Brownell568d0692009-09-22 16:46:18 -07002714}
2715EXPORT_SYMBOL_GPL(spi_async);
2716
Ernst Schwabcf32b712010-06-28 17:49:29 -07002717/**
2718 * spi_async_locked - version of spi_async with exclusive bus usage
2719 * @spi: device with which data will be exchanged
2720 * @message: describes the data transfers, including completion callback
2721 * Context: any (irqs may be blocked, etc)
2722 *
2723 * This call may be used in_irq and other contexts which can't sleep,
2724 * as well as from task contexts which can sleep.
2725 *
2726 * The completion callback is invoked in a context which can't sleep.
2727 * Before that invocation, the value of message->status is undefined.
2728 * When the callback is issued, message->status holds either zero (to
2729 * indicate complete success) or a negative error code. After that
2730 * callback returns, the driver which issued the transfer request may
2731 * deallocate the associated memory; it's no longer in use by any SPI
2732 * core or controller driver code.
2733 *
2734 * Note that although all messages to a spi_device are handled in
2735 * FIFO order, messages may go to different devices in other orders.
2736 * Some device might be higher priority, or have various "hard" access
2737 * time requirements, for example.
2738 *
2739 * On detection of any fault during the transfer, processing of
2740 * the entire message is aborted, and the device is deselected.
2741 * Until returning from the associated message completion callback,
2742 * no other spi_message queued to that device will be processed.
2743 * (This rule applies equally to all the synchronous transfer calls,
2744 * which are wrappers around this core asynchronous primitive.)
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002745 *
2746 * Return: zero on success, else a negative error code.
Ernst Schwabcf32b712010-06-28 17:49:29 -07002747 */
2748int spi_async_locked(struct spi_device *spi, struct spi_message *message)
2749{
2750 struct spi_master *master = spi->master;
2751 int ret;
2752 unsigned long flags;
2753
Mark Brown90808732013-11-13 23:44:15 +00002754 ret = __spi_validate(spi, message);
2755 if (ret != 0)
2756 return ret;
2757
Ernst Schwabcf32b712010-06-28 17:49:29 -07002758 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2759
2760 ret = __spi_async(spi, message);
2761
2762 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2763
2764 return ret;
2765
2766}
2767EXPORT_SYMBOL_GPL(spi_async_locked);
2768
David Brownell7d077192009-06-17 16:26:03 -07002769
Vignesh R556351f2015-12-11 09:39:56 +05302770int spi_flash_read(struct spi_device *spi,
2771 struct spi_flash_read_message *msg)
2772
2773{
2774 struct spi_master *master = spi->master;
Vignesh Rf4502dd2016-06-08 12:18:31 +05302775 struct device *rx_dev = NULL;
Vignesh R556351f2015-12-11 09:39:56 +05302776 int ret;
2777
2778 if ((msg->opcode_nbits == SPI_NBITS_DUAL ||
2779 msg->addr_nbits == SPI_NBITS_DUAL) &&
2780 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
2781 return -EINVAL;
2782 if ((msg->opcode_nbits == SPI_NBITS_QUAD ||
2783 msg->addr_nbits == SPI_NBITS_QUAD) &&
2784 !(spi->mode & SPI_TX_QUAD))
2785 return -EINVAL;
2786 if (msg->data_nbits == SPI_NBITS_DUAL &&
2787 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
2788 return -EINVAL;
2789 if (msg->data_nbits == SPI_NBITS_QUAD &&
2790 !(spi->mode & SPI_RX_QUAD))
2791 return -EINVAL;
2792
2793 if (master->auto_runtime_pm) {
2794 ret = pm_runtime_get_sync(master->dev.parent);
2795 if (ret < 0) {
2796 dev_err(&master->dev, "Failed to power device: %d\n",
2797 ret);
2798 return ret;
2799 }
2800 }
Vignesh Rf4502dd2016-06-08 12:18:31 +05302801
Vignesh R556351f2015-12-11 09:39:56 +05302802 mutex_lock(&master->bus_lock_mutex);
Mark Brownef4d96e2016-07-21 23:53:31 +01002803 mutex_lock(&master->io_mutex);
Vignesh Rf4502dd2016-06-08 12:18:31 +05302804 if (master->dma_rx) {
2805 rx_dev = master->dma_rx->device->dev;
2806 ret = spi_map_buf(master, rx_dev, &msg->rx_sg,
2807 msg->buf, msg->len,
2808 DMA_FROM_DEVICE);
2809 if (!ret)
2810 msg->cur_msg_mapped = true;
2811 }
Vignesh R556351f2015-12-11 09:39:56 +05302812 ret = master->spi_flash_read(spi, msg);
Vignesh Rf4502dd2016-06-08 12:18:31 +05302813 if (msg->cur_msg_mapped)
2814 spi_unmap_buf(master, rx_dev, &msg->rx_sg,
2815 DMA_FROM_DEVICE);
Mark Brownef4d96e2016-07-21 23:53:31 +01002816 mutex_unlock(&master->io_mutex);
Vignesh R556351f2015-12-11 09:39:56 +05302817 mutex_unlock(&master->bus_lock_mutex);
Vignesh Rf4502dd2016-06-08 12:18:31 +05302818
Vignesh R556351f2015-12-11 09:39:56 +05302819 if (master->auto_runtime_pm)
2820 pm_runtime_put(master->dev.parent);
2821
2822 return ret;
2823}
2824EXPORT_SYMBOL_GPL(spi_flash_read);
2825
David Brownell7d077192009-06-17 16:26:03 -07002826/*-------------------------------------------------------------------------*/
2827
2828/* Utility methods for SPI master protocol drivers, layered on
2829 * top of the core. Some other utility methods are defined as
2830 * inline functions.
2831 */
2832
Andrew Morton5d870c82006-01-11 11:23:49 -08002833static void spi_complete(void *arg)
2834{
2835 complete(arg);
2836}
2837
Mark Brownef4d96e2016-07-21 23:53:31 +01002838static int __spi_sync(struct spi_device *spi, struct spi_message *message)
Ernst Schwabcf32b712010-06-28 17:49:29 -07002839{
2840 DECLARE_COMPLETION_ONSTACK(done);
2841 int status;
2842 struct spi_master *master = spi->master;
Mark Brown0461a412014-12-09 21:38:05 +00002843 unsigned long flags;
2844
2845 status = __spi_validate(spi, message);
2846 if (status != 0)
2847 return status;
Ernst Schwabcf32b712010-06-28 17:49:29 -07002848
2849 message->complete = spi_complete;
2850 message->context = &done;
Mark Brown0461a412014-12-09 21:38:05 +00002851 message->spi = spi;
Ernst Schwabcf32b712010-06-28 17:49:29 -07002852
Martin Sperleca2ebc2015-06-22 13:00:36 +00002853 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics, spi_sync);
2854 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_sync);
2855
Mark Brown0461a412014-12-09 21:38:05 +00002856 /* If we're not using the legacy transfer method then we will
2857 * try to transfer in the calling context so special case.
2858 * This code would be less tricky if we could remove the
2859 * support for driver implemented message queues.
2860 */
2861 if (master->transfer == spi_queued_transfer) {
2862 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2863
2864 trace_spi_message_submit(message);
2865
2866 status = __spi_queued_transfer(spi, message, false);
2867
2868 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2869 } else {
2870 status = spi_async_locked(spi, message);
2871 }
Ernst Schwabcf32b712010-06-28 17:49:29 -07002872
Ernst Schwabcf32b712010-06-28 17:49:29 -07002873 if (status == 0) {
Mark Brown0461a412014-12-09 21:38:05 +00002874 /* Push out the messages in the calling context if we
2875 * can.
2876 */
Martin Sperleca2ebc2015-06-22 13:00:36 +00002877 if (master->transfer == spi_queued_transfer) {
2878 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics,
2879 spi_sync_immediate);
2880 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics,
2881 spi_sync_immediate);
Mark Brownef4d96e2016-07-21 23:53:31 +01002882 __spi_pump_messages(master, false);
Martin Sperleca2ebc2015-06-22 13:00:36 +00002883 }
Mark Brown0461a412014-12-09 21:38:05 +00002884
Ernst Schwabcf32b712010-06-28 17:49:29 -07002885 wait_for_completion(&done);
2886 status = message->status;
2887 }
2888 message->context = NULL;
2889 return status;
2890}
2891
David Brownell8ae12a02006-01-08 13:34:19 -08002892/**
2893 * spi_sync - blocking/synchronous SPI data transfers
2894 * @spi: device with which data will be exchanged
2895 * @message: describes the data transfers
David Brownell33e34dc2007-05-08 00:32:21 -07002896 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08002897 *
2898 * This call may only be used from a context that may sleep. The sleep
2899 * is non-interruptible, and has no timeout. Low-overhead controller
2900 * drivers may DMA directly into and out of the message buffers.
2901 *
2902 * Note that the SPI device's chip select is active during the message,
2903 * and then is normally disabled between messages. Drivers for some
2904 * frequently-used devices may want to minimize costs of selecting a chip,
2905 * by leaving it selected in anticipation that the next message will go
2906 * to the same chip. (That may increase power usage.)
2907 *
David Brownell0c868462006-01-08 13:34:25 -08002908 * Also, the caller is guaranteeing that the memory associated with the
2909 * message will not be freed before this call returns.
2910 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002911 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08002912 */
2913int spi_sync(struct spi_device *spi, struct spi_message *message)
2914{
Mark Brownef4d96e2016-07-21 23:53:31 +01002915 int ret;
2916
2917 mutex_lock(&spi->master->bus_lock_mutex);
2918 ret = __spi_sync(spi, message);
2919 mutex_unlock(&spi->master->bus_lock_mutex);
2920
2921 return ret;
David Brownell8ae12a02006-01-08 13:34:19 -08002922}
2923EXPORT_SYMBOL_GPL(spi_sync);
2924
Ernst Schwabcf32b712010-06-28 17:49:29 -07002925/**
2926 * spi_sync_locked - version of spi_sync with exclusive bus usage
2927 * @spi: device with which data will be exchanged
2928 * @message: describes the data transfers
2929 * Context: can sleep
2930 *
2931 * This call may only be used from a context that may sleep. The sleep
2932 * is non-interruptible, and has no timeout. Low-overhead controller
2933 * drivers may DMA directly into and out of the message buffers.
2934 *
2935 * This call should be used by drivers that require exclusive access to the
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002936 * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
Ernst Schwabcf32b712010-06-28 17:49:29 -07002937 * be released by a spi_bus_unlock call when the exclusive access is over.
2938 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002939 * Return: zero on success, else a negative error code.
Ernst Schwabcf32b712010-06-28 17:49:29 -07002940 */
2941int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
2942{
Mark Brownef4d96e2016-07-21 23:53:31 +01002943 return __spi_sync(spi, message);
Ernst Schwabcf32b712010-06-28 17:49:29 -07002944}
2945EXPORT_SYMBOL_GPL(spi_sync_locked);
2946
2947/**
2948 * spi_bus_lock - obtain a lock for exclusive SPI bus usage
2949 * @master: SPI bus master that should be locked for exclusive bus access
2950 * Context: can sleep
2951 *
2952 * This call may only be used from a context that may sleep. The sleep
2953 * is non-interruptible, and has no timeout.
2954 *
2955 * This call should be used by drivers that require exclusive access to the
2956 * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
2957 * exclusive access is over. Data transfer must be done by spi_sync_locked
2958 * and spi_async_locked calls when the SPI bus lock is held.
2959 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002960 * Return: always zero.
Ernst Schwabcf32b712010-06-28 17:49:29 -07002961 */
2962int spi_bus_lock(struct spi_master *master)
2963{
2964 unsigned long flags;
2965
2966 mutex_lock(&master->bus_lock_mutex);
2967
2968 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2969 master->bus_lock_flag = 1;
2970 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2971
2972 /* mutex remains locked until spi_bus_unlock is called */
2973
2974 return 0;
2975}
2976EXPORT_SYMBOL_GPL(spi_bus_lock);
2977
2978/**
2979 * spi_bus_unlock - release the lock for exclusive SPI bus usage
2980 * @master: SPI bus master that was locked for exclusive bus access
2981 * Context: can sleep
2982 *
2983 * This call may only be used from a context that may sleep. The sleep
2984 * is non-interruptible, and has no timeout.
2985 *
2986 * This call releases an SPI bus lock previously obtained by an spi_bus_lock
2987 * call.
2988 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002989 * Return: always zero.
Ernst Schwabcf32b712010-06-28 17:49:29 -07002990 */
2991int spi_bus_unlock(struct spi_master *master)
2992{
2993 master->bus_lock_flag = 0;
2994
2995 mutex_unlock(&master->bus_lock_mutex);
2996
2997 return 0;
2998}
2999EXPORT_SYMBOL_GPL(spi_bus_unlock);
3000
David Brownella9948b62006-04-02 10:37:40 -08003001/* portable code must never pass more than 32 bytes */
Jingoo Han5fe5f052013-10-14 10:31:51 +09003002#define SPI_BUFSIZ max(32, SMP_CACHE_BYTES)
David Brownell8ae12a02006-01-08 13:34:19 -08003003
3004static u8 *buf;
3005
3006/**
3007 * spi_write_then_read - SPI synchronous write followed by read
3008 * @spi: device with which data will be exchanged
3009 * @txbuf: data to be written (need not be dma-safe)
3010 * @n_tx: size of txbuf, in bytes
Jiri Pirko27570492009-06-17 16:26:06 -07003011 * @rxbuf: buffer into which data will be read (need not be dma-safe)
3012 * @n_rx: size of rxbuf, in bytes
David Brownell33e34dc2007-05-08 00:32:21 -07003013 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08003014 *
3015 * This performs a half duplex MicroWire style transaction with the
3016 * device, sending txbuf and then reading rxbuf. The return value
3017 * is zero for success, else a negative errno status code.
David Brownellb8852442006-01-08 13:34:23 -08003018 * This call may only be used from a context that may sleep.
David Brownell8ae12a02006-01-08 13:34:19 -08003019 *
David Brownell0c868462006-01-08 13:34:25 -08003020 * Parameters to this routine are always copied using a small buffer;
David Brownell33e34dc2007-05-08 00:32:21 -07003021 * portable code should never use this for more than 32 bytes.
3022 * Performance-sensitive or bulk transfer code should instead use
David Brownell0c868462006-01-08 13:34:25 -08003023 * spi_{async,sync}() calls with dma-safe buffers.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02003024 *
3025 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08003026 */
3027int spi_write_then_read(struct spi_device *spi,
Mark Brown0c4a1592011-05-11 00:09:30 +02003028 const void *txbuf, unsigned n_tx,
3029 void *rxbuf, unsigned n_rx)
David Brownell8ae12a02006-01-08 13:34:19 -08003030{
David Brownell068f4072007-12-04 23:45:09 -08003031 static DEFINE_MUTEX(lock);
David Brownell8ae12a02006-01-08 13:34:19 -08003032
3033 int status;
3034 struct spi_message message;
David Brownellbdff5492009-04-13 14:39:57 -07003035 struct spi_transfer x[2];
David Brownell8ae12a02006-01-08 13:34:19 -08003036 u8 *local_buf;
3037
Mark Brownb3a223e2012-12-02 12:54:25 +09003038 /* Use preallocated DMA-safe buffer if we can. We can't avoid
3039 * copying here, (as a pure convenience thing), but we can
3040 * keep heap costs out of the hot path unless someone else is
3041 * using the pre-allocated buffer or the transfer is too large.
David Brownell8ae12a02006-01-08 13:34:19 -08003042 */
Mark Brownb3a223e2012-12-02 12:54:25 +09003043 if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
Mark Brown2cd94c82013-01-27 14:35:04 +08003044 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
3045 GFP_KERNEL | GFP_DMA);
Mark Brownb3a223e2012-12-02 12:54:25 +09003046 if (!local_buf)
3047 return -ENOMEM;
3048 } else {
3049 local_buf = buf;
3050 }
David Brownell8ae12a02006-01-08 13:34:19 -08003051
Vitaly Wool8275c642006-01-08 13:34:28 -08003052 spi_message_init(&message);
Jingoo Han5fe5f052013-10-14 10:31:51 +09003053 memset(x, 0, sizeof(x));
David Brownellbdff5492009-04-13 14:39:57 -07003054 if (n_tx) {
3055 x[0].len = n_tx;
3056 spi_message_add_tail(&x[0], &message);
3057 }
3058 if (n_rx) {
3059 x[1].len = n_rx;
3060 spi_message_add_tail(&x[1], &message);
3061 }
Vitaly Wool8275c642006-01-08 13:34:28 -08003062
David Brownell8ae12a02006-01-08 13:34:19 -08003063 memcpy(local_buf, txbuf, n_tx);
David Brownellbdff5492009-04-13 14:39:57 -07003064 x[0].tx_buf = local_buf;
3065 x[1].rx_buf = local_buf + n_tx;
David Brownell8ae12a02006-01-08 13:34:19 -08003066
3067 /* do the i/o */
David Brownell8ae12a02006-01-08 13:34:19 -08003068 status = spi_sync(spi, &message);
Marc Pignat9b938b72007-12-04 23:45:10 -08003069 if (status == 0)
David Brownellbdff5492009-04-13 14:39:57 -07003070 memcpy(rxbuf, x[1].rx_buf, n_rx);
David Brownell8ae12a02006-01-08 13:34:19 -08003071
David Brownellbdff5492009-04-13 14:39:57 -07003072 if (x[0].tx_buf == buf)
David Brownell068f4072007-12-04 23:45:09 -08003073 mutex_unlock(&lock);
David Brownell8ae12a02006-01-08 13:34:19 -08003074 else
3075 kfree(local_buf);
3076
3077 return status;
3078}
3079EXPORT_SYMBOL_GPL(spi_write_then_read);
3080
3081/*-------------------------------------------------------------------------*/
3082
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003083#if IS_ENABLED(CONFIG_OF_DYNAMIC)
3084static int __spi_of_device_match(struct device *dev, void *data)
3085{
3086 return dev->of_node == data;
3087}
3088
3089/* must call put_device() when done with returned spi_device device */
3090static struct spi_device *of_find_spi_device_by_node(struct device_node *node)
3091{
3092 struct device *dev = bus_find_device(&spi_bus_type, NULL, node,
3093 __spi_of_device_match);
3094 return dev ? to_spi_device(dev) : NULL;
3095}
3096
3097static int __spi_of_master_match(struct device *dev, const void *data)
3098{
3099 return dev->of_node == data;
3100}
3101
3102/* the spi masters are not using spi_bus, so we find it with another way */
3103static struct spi_master *of_find_spi_master_by_node(struct device_node *node)
3104{
3105 struct device *dev;
3106
3107 dev = class_find_device(&spi_master_class, NULL, node,
3108 __spi_of_master_match);
3109 if (!dev)
3110 return NULL;
3111
3112 /* reference got in class_find_device */
3113 return container_of(dev, struct spi_master, dev);
3114}
3115
3116static int of_spi_notify(struct notifier_block *nb, unsigned long action,
3117 void *arg)
3118{
3119 struct of_reconfig_data *rd = arg;
3120 struct spi_master *master;
3121 struct spi_device *spi;
3122
3123 switch (of_reconfig_get_state_change(action, arg)) {
3124 case OF_RECONFIG_CHANGE_ADD:
3125 master = of_find_spi_master_by_node(rd->dn->parent);
3126 if (master == NULL)
3127 return NOTIFY_OK; /* not for us */
3128
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +01003129 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED)) {
3130 put_device(&master->dev);
3131 return NOTIFY_OK;
3132 }
3133
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003134 spi = of_register_spi_device(master, rd->dn);
3135 put_device(&master->dev);
3136
3137 if (IS_ERR(spi)) {
3138 pr_err("%s: failed to create for '%s'\n",
3139 __func__, rd->dn->full_name);
Ralf Ramsauere0af98a2016-10-17 15:59:56 +02003140 of_node_clear_flag(rd->dn, OF_POPULATED);
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003141 return notifier_from_errno(PTR_ERR(spi));
3142 }
3143 break;
3144
3145 case OF_RECONFIG_CHANGE_REMOVE:
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +01003146 /* already depopulated? */
3147 if (!of_node_check_flag(rd->dn, OF_POPULATED))
3148 return NOTIFY_OK;
3149
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003150 /* find our device by node */
3151 spi = of_find_spi_device_by_node(rd->dn);
3152 if (spi == NULL)
3153 return NOTIFY_OK; /* no? not meant for us */
3154
3155 /* unregister takes one ref away */
3156 spi_unregister_device(spi);
3157
3158 /* and put the reference of the find */
3159 put_device(&spi->dev);
3160 break;
3161 }
3162
3163 return NOTIFY_OK;
3164}
3165
3166static struct notifier_block spi_of_notifier = {
3167 .notifier_call = of_spi_notify,
3168};
3169#else /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
3170extern struct notifier_block spi_of_notifier;
3171#endif /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
3172
Octavian Purdila7f244672016-07-08 19:13:11 +03003173#if IS_ENABLED(CONFIG_ACPI)
3174static int spi_acpi_master_match(struct device *dev, const void *data)
3175{
3176 return ACPI_COMPANION(dev->parent) == data;
3177}
3178
3179static int spi_acpi_device_match(struct device *dev, void *data)
3180{
3181 return ACPI_COMPANION(dev) == data;
3182}
3183
3184static struct spi_master *acpi_spi_find_master_by_adev(struct acpi_device *adev)
3185{
3186 struct device *dev;
3187
3188 dev = class_find_device(&spi_master_class, NULL, adev,
3189 spi_acpi_master_match);
3190 if (!dev)
3191 return NULL;
3192
3193 return container_of(dev, struct spi_master, dev);
3194}
3195
3196static struct spi_device *acpi_spi_find_device_by_adev(struct acpi_device *adev)
3197{
3198 struct device *dev;
3199
3200 dev = bus_find_device(&spi_bus_type, NULL, adev, spi_acpi_device_match);
3201
3202 return dev ? to_spi_device(dev) : NULL;
3203}
3204
3205static int acpi_spi_notify(struct notifier_block *nb, unsigned long value,
3206 void *arg)
3207{
3208 struct acpi_device *adev = arg;
3209 struct spi_master *master;
3210 struct spi_device *spi;
3211
3212 switch (value) {
3213 case ACPI_RECONFIG_DEVICE_ADD:
3214 master = acpi_spi_find_master_by_adev(adev->parent);
3215 if (!master)
3216 break;
3217
3218 acpi_register_spi_device(master, adev);
3219 put_device(&master->dev);
3220 break;
3221 case ACPI_RECONFIG_DEVICE_REMOVE:
3222 if (!acpi_device_enumerated(adev))
3223 break;
3224
3225 spi = acpi_spi_find_device_by_adev(adev);
3226 if (!spi)
3227 break;
3228
3229 spi_unregister_device(spi);
3230 put_device(&spi->dev);
3231 break;
3232 }
3233
3234 return NOTIFY_OK;
3235}
3236
3237static struct notifier_block spi_acpi_notifier = {
3238 .notifier_call = acpi_spi_notify,
3239};
3240#else
3241extern struct notifier_block spi_acpi_notifier;
3242#endif
3243
David Brownell8ae12a02006-01-08 13:34:19 -08003244static int __init spi_init(void)
3245{
David Brownellb8852442006-01-08 13:34:23 -08003246 int status;
David Brownell8ae12a02006-01-08 13:34:19 -08003247
Christoph Lametere94b1762006-12-06 20:33:17 -08003248 buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
David Brownellb8852442006-01-08 13:34:23 -08003249 if (!buf) {
3250 status = -ENOMEM;
3251 goto err0;
3252 }
3253
3254 status = bus_register(&spi_bus_type);
3255 if (status < 0)
3256 goto err1;
3257
3258 status = class_register(&spi_master_class);
3259 if (status < 0)
3260 goto err2;
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003261
Fabio Estevam52677202014-11-26 20:13:57 -02003262 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003263 WARN_ON(of_reconfig_notifier_register(&spi_of_notifier));
Octavian Purdila7f244672016-07-08 19:13:11 +03003264 if (IS_ENABLED(CONFIG_ACPI))
3265 WARN_ON(acpi_reconfig_notifier_register(&spi_acpi_notifier));
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003266
David Brownell8ae12a02006-01-08 13:34:19 -08003267 return 0;
David Brownellb8852442006-01-08 13:34:23 -08003268
3269err2:
3270 bus_unregister(&spi_bus_type);
3271err1:
3272 kfree(buf);
3273 buf = NULL;
3274err0:
3275 return status;
David Brownell8ae12a02006-01-08 13:34:19 -08003276}
David Brownellb8852442006-01-08 13:34:23 -08003277
David Brownell8ae12a02006-01-08 13:34:19 -08003278/* board_info is normally registered in arch_initcall(),
3279 * but even essential drivers wait till later
David Brownellb8852442006-01-08 13:34:23 -08003280 *
3281 * REVISIT only boardinfo really needs static linking. the rest (device and
3282 * driver registration) _could_ be dynamically linked (modular) ... costs
3283 * include needing to have boardinfo data structures be much more public.
David Brownell8ae12a02006-01-08 13:34:19 -08003284 */
David Brownell673c0c02008-10-15 22:02:46 -07003285postcore_initcall(spi_init);
David Brownell8ae12a02006-01-08 13:34:19 -08003286