blob: ad7f638a0a5ba5556df9cc0f72c060bedbb0f80e [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 Brownell0c8684612006-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
624 if (spi->dev.of_node)
625 of_node_clear_flag(spi->dev.of_node, OF_POPULATED);
Octavian Purdila7f244672016-07-08 19:13:11 +0300626 if (ACPI_COMPANION(&spi->dev))
627 acpi_device_clear_enumerated(ACPI_COMPANION(&spi->dev));
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +0100628 device_unregister(&spi->dev);
Geert Uytterhoeven3b1884c2015-11-30 15:28:06 +0100629}
630EXPORT_SYMBOL_GPL(spi_unregister_device);
631
Feng Tang2b9603a2010-08-02 15:52:15 +0800632static void spi_match_master_to_boardinfo(struct spi_master *master,
633 struct spi_board_info *bi)
634{
635 struct spi_device *dev;
636
637 if (master->bus_num != bi->bus_num)
638 return;
639
640 dev = spi_new_device(master, bi);
641 if (!dev)
642 dev_err(master->dev.parent, "can't create new device for %s\n",
643 bi->modalias);
644}
645
David Brownell33e34dc2007-05-08 00:32:21 -0700646/**
647 * spi_register_board_info - register SPI devices for a given board
648 * @info: array of chip descriptors
649 * @n: how many descriptors are provided
650 * Context: can sleep
651 *
David Brownell8ae12a02006-01-08 13:34:19 -0800652 * Board-specific early init code calls this (probably during arch_initcall)
653 * with segments of the SPI device table. Any device nodes are created later,
654 * after the relevant parent SPI controller (bus_num) is defined. We keep
655 * this table of devices forever, so that reloading a controller driver will
656 * not make Linux forget about these hard-wired devices.
657 *
658 * Other code can also call this, e.g. a particular add-on board might provide
659 * SPI devices through its expansion connector, so code initializing that board
660 * would naturally declare its SPI devices.
661 *
662 * The board info passed can safely be __initdata ... but be careful of
663 * any embedded pointers (platform_data, etc), they're copied as-is.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200664 *
665 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -0800666 */
Grant Likelyfd4a3192012-12-07 16:57:14 +0000667int spi_register_board_info(struct spi_board_info const *info, unsigned n)
David Brownell8ae12a02006-01-08 13:34:19 -0800668{
Feng Tang2b9603a2010-08-02 15:52:15 +0800669 struct boardinfo *bi;
670 int i;
David Brownell8ae12a02006-01-08 13:34:19 -0800671
Xiubo Lic7908a32014-09-24 14:30:29 +0800672 if (!n)
673 return -EINVAL;
674
Feng Tang2b9603a2010-08-02 15:52:15 +0800675 bi = kzalloc(n * sizeof(*bi), GFP_KERNEL);
David Brownell8ae12a02006-01-08 13:34:19 -0800676 if (!bi)
677 return -ENOMEM;
David Brownell8ae12a02006-01-08 13:34:19 -0800678
Feng Tang2b9603a2010-08-02 15:52:15 +0800679 for (i = 0; i < n; i++, bi++, info++) {
680 struct spi_master *master;
David Brownell8ae12a02006-01-08 13:34:19 -0800681
Feng Tang2b9603a2010-08-02 15:52:15 +0800682 memcpy(&bi->board_info, info, sizeof(*info));
683 mutex_lock(&board_lock);
684 list_add_tail(&bi->list, &board_list);
685 list_for_each_entry(master, &spi_master_list, list)
686 spi_match_master_to_boardinfo(master, &bi->board_info);
687 mutex_unlock(&board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800688 }
Feng Tang2b9603a2010-08-02 15:52:15 +0800689
690 return 0;
David Brownell8ae12a02006-01-08 13:34:19 -0800691}
692
693/*-------------------------------------------------------------------------*/
694
Mark Brownb1589352013-10-05 11:50:40 +0100695static void spi_set_cs(struct spi_device *spi, bool enable)
696{
697 if (spi->mode & SPI_CS_HIGH)
698 enable = !enable;
699
Thor Thayer8eee6b92016-10-10 09:25:24 -0500700 if (gpio_is_valid(spi->cs_gpio)) {
Mark Brownb1589352013-10-05 11:50:40 +0100701 gpio_set_value(spi->cs_gpio, !enable);
Thor Thayer8eee6b92016-10-10 09:25:24 -0500702 /* Some SPI masters need both GPIO CS & slave_select */
703 if ((spi->master->flags & SPI_MASTER_GPIO_SS) &&
704 spi->master->set_cs)
705 spi->master->set_cs(spi, !enable);
706 } else if (spi->master->set_cs) {
Mark Brownb1589352013-10-05 11:50:40 +0100707 spi->master->set_cs(spi, !enable);
Thor Thayer8eee6b92016-10-10 09:25:24 -0500708 }
Mark Brownb1589352013-10-05 11:50:40 +0100709}
710
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200711#ifdef CONFIG_HAS_DMA
Mark Brown6ad45a22014-02-02 13:47:47 +0000712static int spi_map_buf(struct spi_master *master, struct device *dev,
713 struct sg_table *sgt, void *buf, size_t len,
714 enum dma_data_direction dir)
715{
716 const bool vmalloced_buf = is_vmalloc_addr(buf);
Andy Shevchenkodf88e912016-03-09 11:20:00 +0200717 unsigned int max_seg_size = dma_get_max_seg_size(dev);
Vignesh Rb1b81532016-08-17 15:22:36 +0530718#ifdef CONFIG_HIGHMEM
719 const bool kmap_buf = ((unsigned long)buf >= PKMAP_BASE &&
720 (unsigned long)buf < (PKMAP_BASE +
721 (LAST_PKMAP * PAGE_SIZE)));
722#else
723 const bool kmap_buf = false;
724#endif
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500725 int desc_len;
726 int sgs;
Mark Brown6ad45a22014-02-02 13:47:47 +0000727 struct page *vm_page;
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600728 struct scatterlist *sg;
Mark Brown6ad45a22014-02-02 13:47:47 +0000729 void *sg_buf;
730 size_t min;
731 int i, ret;
732
Vignesh Rb1b81532016-08-17 15:22:36 +0530733 if (vmalloced_buf || kmap_buf) {
Andy Shevchenkodf88e912016-03-09 11:20:00 +0200734 desc_len = min_t(int, max_seg_size, PAGE_SIZE);
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500735 sgs = DIV_ROUND_UP(len + offset_in_page(buf), desc_len);
Vignesh R0569a882016-04-25 15:14:00 +0530736 } else if (virt_addr_valid(buf)) {
Andy Shevchenkodf88e912016-03-09 11:20:00 +0200737 desc_len = min_t(int, max_seg_size, master->max_dma_len);
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500738 sgs = DIV_ROUND_UP(len, desc_len);
Vignesh R0569a882016-04-25 15:14:00 +0530739 } else {
740 return -EINVAL;
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500741 }
742
Mark Brown6ad45a22014-02-02 13:47:47 +0000743 ret = sg_alloc_table(sgt, sgs, GFP_KERNEL);
744 if (ret != 0)
745 return ret;
746
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600747 sg = &sgt->sgl[0];
Mark Brown6ad45a22014-02-02 13:47:47 +0000748 for (i = 0; i < sgs; i++) {
Mark Brown6ad45a22014-02-02 13:47:47 +0000749
Vignesh Rb1b81532016-08-17 15:22:36 +0530750 if (vmalloced_buf || kmap_buf) {
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500751 min = min_t(size_t,
752 len, desc_len - offset_in_page(buf));
Vignesh Rb1b81532016-08-17 15:22:36 +0530753 if (vmalloced_buf)
754 vm_page = vmalloc_to_page(buf);
755 else
756 vm_page = kmap_to_page(buf);
Mark Brown6ad45a22014-02-02 13:47:47 +0000757 if (!vm_page) {
758 sg_free_table(sgt);
759 return -ENOMEM;
760 }
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600761 sg_set_page(sg, vm_page,
Charles Keepaxc1aefbd2014-11-17 09:14:31 +0000762 min, offset_in_page(buf));
Mark Brown6ad45a22014-02-02 13:47:47 +0000763 } else {
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500764 min = min_t(size_t, len, desc_len);
Mark Brown6ad45a22014-02-02 13:47:47 +0000765 sg_buf = buf;
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600766 sg_set_buf(sg, sg_buf, min);
Mark Brown6ad45a22014-02-02 13:47:47 +0000767 }
768
Mark Brown6ad45a22014-02-02 13:47:47 +0000769 buf += min;
770 len -= min;
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600771 sg = sg_next(sg);
Mark Brown6ad45a22014-02-02 13:47:47 +0000772 }
773
774 ret = dma_map_sg(dev, sgt->sgl, sgt->nents, dir);
Geert Uytterhoeven89e4b662014-07-10 15:29:32 +0200775 if (!ret)
776 ret = -ENOMEM;
Mark Brown6ad45a22014-02-02 13:47:47 +0000777 if (ret < 0) {
778 sg_free_table(sgt);
779 return ret;
780 }
781
782 sgt->nents = ret;
783
784 return 0;
785}
786
787static void spi_unmap_buf(struct spi_master *master, struct device *dev,
788 struct sg_table *sgt, enum dma_data_direction dir)
789{
790 if (sgt->orig_nents) {
791 dma_unmap_sg(dev, sgt->sgl, sgt->orig_nents, dir);
792 sg_free_table(sgt);
793 }
794}
795
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200796static int __spi_map_msg(struct spi_master *master, struct spi_message *msg)
Mark Brown99adef32014-01-16 12:22:43 +0000797{
Mark Brown99adef32014-01-16 12:22:43 +0000798 struct device *tx_dev, *rx_dev;
799 struct spi_transfer *xfer;
Mark Brown6ad45a22014-02-02 13:47:47 +0000800 int ret;
Mark Brown3a2eba92014-01-28 20:17:03 +0000801
Mark Brown6ad45a22014-02-02 13:47:47 +0000802 if (!master->can_dma)
Mark Brown99adef32014-01-16 12:22:43 +0000803 return 0;
804
Leilk Liuc37f45b2015-07-23 17:10:40 +0800805 if (master->dma_tx)
806 tx_dev = master->dma_tx->device->dev;
807 else
808 tx_dev = &master->dev;
809
810 if (master->dma_rx)
811 rx_dev = master->dma_rx->device->dev;
812 else
813 rx_dev = &master->dev;
Mark Brown99adef32014-01-16 12:22:43 +0000814
815 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
816 if (!master->can_dma(master, msg->spi, xfer))
817 continue;
818
819 if (xfer->tx_buf != NULL) {
Mark Brown6ad45a22014-02-02 13:47:47 +0000820 ret = spi_map_buf(master, tx_dev, &xfer->tx_sg,
821 (void *)xfer->tx_buf, xfer->len,
822 DMA_TO_DEVICE);
823 if (ret != 0)
824 return ret;
Mark Brown99adef32014-01-16 12:22:43 +0000825 }
826
827 if (xfer->rx_buf != NULL) {
Mark Brown6ad45a22014-02-02 13:47:47 +0000828 ret = spi_map_buf(master, rx_dev, &xfer->rx_sg,
829 xfer->rx_buf, xfer->len,
830 DMA_FROM_DEVICE);
831 if (ret != 0) {
832 spi_unmap_buf(master, tx_dev, &xfer->tx_sg,
833 DMA_TO_DEVICE);
834 return ret;
Mark Brown99adef32014-01-16 12:22:43 +0000835 }
836 }
837 }
838
839 master->cur_msg_mapped = true;
840
841 return 0;
842}
843
Martin Sperl4b786452015-05-25 10:13:10 +0000844static int __spi_unmap_msg(struct spi_master *master, struct spi_message *msg)
Mark Brown99adef32014-01-16 12:22:43 +0000845{
846 struct spi_transfer *xfer;
847 struct device *tx_dev, *rx_dev;
848
Mark Brown6ad45a22014-02-02 13:47:47 +0000849 if (!master->cur_msg_mapped || !master->can_dma)
Mark Brown99adef32014-01-16 12:22:43 +0000850 return 0;
851
Leilk Liuc37f45b2015-07-23 17:10:40 +0800852 if (master->dma_tx)
853 tx_dev = master->dma_tx->device->dev;
854 else
855 tx_dev = &master->dev;
856
857 if (master->dma_rx)
858 rx_dev = master->dma_rx->device->dev;
859 else
860 rx_dev = &master->dev;
Mark Brown99adef32014-01-16 12:22:43 +0000861
862 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
863 if (!master->can_dma(master, msg->spi, xfer))
864 continue;
865
Mark Brown6ad45a22014-02-02 13:47:47 +0000866 spi_unmap_buf(master, rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
867 spi_unmap_buf(master, tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
Mark Brown99adef32014-01-16 12:22:43 +0000868 }
869
870 return 0;
871}
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200872#else /* !CONFIG_HAS_DMA */
Vignesh Rf4502dd2016-06-08 12:18:31 +0530873static inline int spi_map_buf(struct spi_master *master,
874 struct device *dev, struct sg_table *sgt,
875 void *buf, size_t len,
876 enum dma_data_direction dir)
877{
878 return -EINVAL;
879}
880
881static inline void spi_unmap_buf(struct spi_master *master,
882 struct device *dev, struct sg_table *sgt,
883 enum dma_data_direction dir)
884{
885}
886
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200887static inline int __spi_map_msg(struct spi_master *master,
888 struct spi_message *msg)
889{
890 return 0;
891}
892
Martin Sperl4b786452015-05-25 10:13:10 +0000893static inline int __spi_unmap_msg(struct spi_master *master,
894 struct spi_message *msg)
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200895{
896 return 0;
897}
898#endif /* !CONFIG_HAS_DMA */
899
Martin Sperl4b786452015-05-25 10:13:10 +0000900static inline int spi_unmap_msg(struct spi_master *master,
901 struct spi_message *msg)
902{
903 struct spi_transfer *xfer;
904
905 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
906 /*
907 * Restore the original value of tx_buf or rx_buf if they are
908 * NULL.
909 */
910 if (xfer->tx_buf == master->dummy_tx)
911 xfer->tx_buf = NULL;
912 if (xfer->rx_buf == master->dummy_rx)
913 xfer->rx_buf = NULL;
914 }
915
916 return __spi_unmap_msg(master, msg);
917}
918
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200919static int spi_map_msg(struct spi_master *master, struct spi_message *msg)
920{
921 struct spi_transfer *xfer;
922 void *tmp;
923 unsigned int max_tx, max_rx;
924
925 if (master->flags & (SPI_MASTER_MUST_RX | SPI_MASTER_MUST_TX)) {
926 max_tx = 0;
927 max_rx = 0;
928
929 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
930 if ((master->flags & SPI_MASTER_MUST_TX) &&
931 !xfer->tx_buf)
932 max_tx = max(xfer->len, max_tx);
933 if ((master->flags & SPI_MASTER_MUST_RX) &&
934 !xfer->rx_buf)
935 max_rx = max(xfer->len, max_rx);
936 }
937
938 if (max_tx) {
939 tmp = krealloc(master->dummy_tx, max_tx,
940 GFP_KERNEL | GFP_DMA);
941 if (!tmp)
942 return -ENOMEM;
943 master->dummy_tx = tmp;
944 memset(tmp, 0, max_tx);
945 }
946
947 if (max_rx) {
948 tmp = krealloc(master->dummy_rx, max_rx,
949 GFP_KERNEL | GFP_DMA);
950 if (!tmp)
951 return -ENOMEM;
952 master->dummy_rx = tmp;
953 }
954
955 if (max_tx || max_rx) {
956 list_for_each_entry(xfer, &msg->transfers,
957 transfer_list) {
958 if (!xfer->tx_buf)
959 xfer->tx_buf = master->dummy_tx;
960 if (!xfer->rx_buf)
961 xfer->rx_buf = master->dummy_rx;
962 }
963 }
964 }
965
966 return __spi_map_msg(master, msg);
967}
Mark Brown99adef32014-01-16 12:22:43 +0000968
Mark Brownb1589352013-10-05 11:50:40 +0100969/*
970 * spi_transfer_one_message - Default implementation of transfer_one_message()
971 *
972 * This is a standard implementation of transfer_one_message() for
Moritz Fischer8ba811a2016-05-03 11:59:30 -0700973 * drivers which implement a transfer_one() operation. It provides
Mark Brownb1589352013-10-05 11:50:40 +0100974 * standard handling of delays and chip select management.
975 */
976static int spi_transfer_one_message(struct spi_master *master,
977 struct spi_message *msg)
978{
979 struct spi_transfer *xfer;
Mark Brownb1589352013-10-05 11:50:40 +0100980 bool keep_cs = false;
981 int ret = 0;
Sien Wud0716dd2016-09-01 18:24:29 -0500982 unsigned long long ms = 1;
Martin Sperleca2ebc2015-06-22 13:00:36 +0000983 struct spi_statistics *statm = &master->statistics;
984 struct spi_statistics *stats = &msg->spi->statistics;
Mark Brownb1589352013-10-05 11:50:40 +0100985
986 spi_set_cs(msg->spi, true);
987
Martin Sperleca2ebc2015-06-22 13:00:36 +0000988 SPI_STATISTICS_INCREMENT_FIELD(statm, messages);
989 SPI_STATISTICS_INCREMENT_FIELD(stats, messages);
990
Mark Brownb1589352013-10-05 11:50:40 +0100991 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
992 trace_spi_transfer_start(msg, xfer);
993
Martin Sperleca2ebc2015-06-22 13:00:36 +0000994 spi_statistics_add_transfer_stats(statm, xfer, master);
995 spi_statistics_add_transfer_stats(stats, xfer, master);
996
Mark Brown38ec10f2014-08-16 16:27:41 +0100997 if (xfer->tx_buf || xfer->rx_buf) {
998 reinit_completion(&master->xfer_completion);
Mark Brownb1589352013-10-05 11:50:40 +0100999
Mark Brown38ec10f2014-08-16 16:27:41 +01001000 ret = master->transfer_one(master, msg->spi, xfer);
1001 if (ret < 0) {
Martin Sperleca2ebc2015-06-22 13:00:36 +00001002 SPI_STATISTICS_INCREMENT_FIELD(statm,
1003 errors);
1004 SPI_STATISTICS_INCREMENT_FIELD(stats,
1005 errors);
Mark Brown38ec10f2014-08-16 16:27:41 +01001006 dev_err(&msg->spi->dev,
1007 "SPI transfer failed: %d\n", ret);
1008 goto out;
1009 }
Mark Brownb1589352013-10-05 11:50:40 +01001010
Mark Brown38ec10f2014-08-16 16:27:41 +01001011 if (ret > 0) {
1012 ret = 0;
Sien Wud0716dd2016-09-01 18:24:29 -05001013 ms = 8LL * 1000LL * xfer->len;
1014 do_div(ms, xfer->speed_hz);
Mark Brown38ec10f2014-08-16 16:27:41 +01001015 ms += ms + 100; /* some tolerance */
Mark Brown16a0ce42014-01-30 22:16:41 +00001016
Sien Wud0716dd2016-09-01 18:24:29 -05001017 if (ms > UINT_MAX)
1018 ms = UINT_MAX;
1019
Mark Brown38ec10f2014-08-16 16:27:41 +01001020 ms = wait_for_completion_timeout(&master->xfer_completion,
1021 msecs_to_jiffies(ms));
1022 }
Mark Brown16a0ce42014-01-30 22:16:41 +00001023
Mark Brown38ec10f2014-08-16 16:27:41 +01001024 if (ms == 0) {
Martin Sperleca2ebc2015-06-22 13:00:36 +00001025 SPI_STATISTICS_INCREMENT_FIELD(statm,
1026 timedout);
1027 SPI_STATISTICS_INCREMENT_FIELD(stats,
1028 timedout);
Mark Brown38ec10f2014-08-16 16:27:41 +01001029 dev_err(&msg->spi->dev,
1030 "SPI transfer timed out\n");
1031 msg->status = -ETIMEDOUT;
1032 }
1033 } else {
1034 if (xfer->len)
1035 dev_err(&msg->spi->dev,
1036 "Bufferless transfer has length %u\n",
1037 xfer->len);
Axel Lin13a42792014-01-18 22:05:22 +08001038 }
Mark Brownb1589352013-10-05 11:50:40 +01001039
1040 trace_spi_transfer_stop(msg, xfer);
1041
1042 if (msg->status != -EINPROGRESS)
1043 goto out;
1044
Daniel Kurtz8244bd32016-10-07 18:55:47 +08001045 if (xfer->delay_usecs) {
1046 u16 us = xfer->delay_usecs;
1047
1048 if (us <= 10)
1049 udelay(us);
1050 else
1051 usleep_range(us, us + DIV_ROUND_UP(us, 10));
1052 }
Mark Brownb1589352013-10-05 11:50:40 +01001053
1054 if (xfer->cs_change) {
1055 if (list_is_last(&xfer->transfer_list,
1056 &msg->transfers)) {
1057 keep_cs = true;
1058 } else {
Mark Brown0b73aa62014-03-29 23:48:07 +00001059 spi_set_cs(msg->spi, false);
1060 udelay(10);
1061 spi_set_cs(msg->spi, true);
Mark Brownb1589352013-10-05 11:50:40 +01001062 }
1063 }
1064
1065 msg->actual_length += xfer->len;
1066 }
1067
1068out:
1069 if (ret != 0 || !keep_cs)
1070 spi_set_cs(msg->spi, false);
1071
1072 if (msg->status == -EINPROGRESS)
1073 msg->status = ret;
1074
Geert Uytterhoevenff61eb42015-04-07 20:39:19 +02001075 if (msg->status && master->handle_err)
Andy Shevchenkob716c4f2015-02-27 17:34:15 +02001076 master->handle_err(master, msg);
1077
Martin Sperld780c372015-12-14 15:20:18 +00001078 spi_res_release(master, msg);
1079
Mark Brownb1589352013-10-05 11:50:40 +01001080 spi_finalize_current_message(master);
1081
1082 return ret;
1083}
1084
1085/**
1086 * spi_finalize_current_transfer - report completion of a transfer
Thierry Reding2c675682014-08-08 13:02:36 +02001087 * @master: the master reporting completion
Mark Brownb1589352013-10-05 11:50:40 +01001088 *
1089 * Called by SPI drivers using the core transfer_one_message()
1090 * implementation to notify it that the current interrupt driven
Geert Uytterhoeven9e8f4882014-01-21 16:10:05 +01001091 * transfer has finished and the next one may be scheduled.
Mark Brownb1589352013-10-05 11:50:40 +01001092 */
1093void spi_finalize_current_transfer(struct spi_master *master)
1094{
1095 complete(&master->xfer_completion);
1096}
1097EXPORT_SYMBOL_GPL(spi_finalize_current_transfer);
1098
Linus Walleijffbbdd212012-02-22 10:05:38 +01001099/**
Mark Brownfc9e0f72014-12-10 13:46:33 +00001100 * __spi_pump_messages - function which processes spi message queue
1101 * @master: master to process queue for
1102 * @in_kthread: true if we are in the context of the message pump thread
Linus Walleijffbbdd212012-02-22 10:05:38 +01001103 *
1104 * This function checks if there is any spi message in the queue that
1105 * needs processing and if so call out to the driver to initialize hardware
1106 * and transfer each message.
1107 *
Mark Brown0461a412014-12-09 21:38:05 +00001108 * Note that it is called both from the kthread itself and also from
1109 * inside spi_sync(); the queue extraction handling at the top of the
1110 * function should deal with this safely.
Linus Walleijffbbdd212012-02-22 10:05:38 +01001111 */
Mark Brownef4d96e2016-07-21 23:53:31 +01001112static void __spi_pump_messages(struct spi_master *master, bool in_kthread)
Linus Walleijffbbdd212012-02-22 10:05:38 +01001113{
Linus Walleijffbbdd212012-02-22 10:05:38 +01001114 unsigned long flags;
1115 bool was_busy = false;
1116 int ret;
1117
Mark Brown983aee52014-12-09 19:46:56 +00001118 /* Lock queue */
Linus Walleijffbbdd212012-02-22 10:05:38 +01001119 spin_lock_irqsave(&master->queue_lock, flags);
Mark Brown983aee52014-12-09 19:46:56 +00001120
1121 /* Make sure we are not already running a message */
1122 if (master->cur_msg) {
1123 spin_unlock_irqrestore(&master->queue_lock, flags);
1124 return;
1125 }
1126
Mark Brown0461a412014-12-09 21:38:05 +00001127 /* If another context is idling the device then defer */
1128 if (master->idling) {
Petr Mladek39891442016-10-11 13:55:20 -07001129 kthread_queue_work(&master->kworker, &master->pump_messages);
Mark Brown0461a412014-12-09 21:38:05 +00001130 spin_unlock_irqrestore(&master->queue_lock, flags);
1131 return;
1132 }
1133
Mark Brown983aee52014-12-09 19:46:56 +00001134 /* Check if the queue is idle */
Linus Walleijffbbdd212012-02-22 10:05:38 +01001135 if (list_empty(&master->queue) || !master->running) {
Bryan Freedb0b36b82013-03-13 11:17:40 -07001136 if (!master->busy) {
1137 spin_unlock_irqrestore(&master->queue_lock, flags);
1138 return;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001139 }
Mark Brownfc9e0f72014-12-10 13:46:33 +00001140
1141 /* Only do teardown in the thread */
1142 if (!in_kthread) {
Petr Mladek39891442016-10-11 13:55:20 -07001143 kthread_queue_work(&master->kworker,
Mark Brownfc9e0f72014-12-10 13:46:33 +00001144 &master->pump_messages);
1145 spin_unlock_irqrestore(&master->queue_lock, flags);
1146 return;
1147 }
1148
Linus Walleijffbbdd212012-02-22 10:05:38 +01001149 master->busy = false;
Mark Brown0461a412014-12-09 21:38:05 +00001150 master->idling = true;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001151 spin_unlock_irqrestore(&master->queue_lock, flags);
Mark Brown0461a412014-12-09 21:38:05 +00001152
Mark Brown3a2eba92014-01-28 20:17:03 +00001153 kfree(master->dummy_rx);
1154 master->dummy_rx = NULL;
1155 kfree(master->dummy_tx);
1156 master->dummy_tx = NULL;
Bryan Freedb0b36b82013-03-13 11:17:40 -07001157 if (master->unprepare_transfer_hardware &&
1158 master->unprepare_transfer_hardware(master))
1159 dev_err(&master->dev,
1160 "failed to unprepare transfer hardware\n");
Mark Brown49834de2013-07-28 14:47:02 +01001161 if (master->auto_runtime_pm) {
1162 pm_runtime_mark_last_busy(master->dev.parent);
1163 pm_runtime_put_autosuspend(master->dev.parent);
1164 }
Mark Brown56ec1972013-10-07 19:33:53 +01001165 trace_spi_master_idle(master);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001166
Mark Brown0461a412014-12-09 21:38:05 +00001167 spin_lock_irqsave(&master->queue_lock, flags);
1168 master->idling = false;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001169 spin_unlock_irqrestore(&master->queue_lock, flags);
1170 return;
1171 }
Linus Walleijffbbdd212012-02-22 10:05:38 +01001172
Linus Walleijffbbdd212012-02-22 10:05:38 +01001173 /* Extract head of queue */
1174 master->cur_msg =
Axel Lina89e2d22014-01-09 16:03:58 +08001175 list_first_entry(&master->queue, struct spi_message, queue);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001176
1177 list_del_init(&master->cur_msg->queue);
1178 if (master->busy)
1179 was_busy = true;
1180 else
1181 master->busy = true;
1182 spin_unlock_irqrestore(&master->queue_lock, flags);
1183
Mark Brownef4d96e2016-07-21 23:53:31 +01001184 mutex_lock(&master->io_mutex);
1185
Mark Brown49834de2013-07-28 14:47:02 +01001186 if (!was_busy && master->auto_runtime_pm) {
1187 ret = pm_runtime_get_sync(master->dev.parent);
1188 if (ret < 0) {
1189 dev_err(&master->dev, "Failed to power device: %d\n",
1190 ret);
Mark Brown764f2162016-08-09 17:45:33 +01001191 mutex_unlock(&master->io_mutex);
Mark Brown49834de2013-07-28 14:47:02 +01001192 return;
1193 }
1194 }
1195
Mark Brown56ec1972013-10-07 19:33:53 +01001196 if (!was_busy)
1197 trace_spi_master_busy(master);
1198
Shubhrajyoti D7dfd2bd2012-05-10 19:20:41 +05301199 if (!was_busy && master->prepare_transfer_hardware) {
Linus Walleijffbbdd212012-02-22 10:05:38 +01001200 ret = master->prepare_transfer_hardware(master);
1201 if (ret) {
1202 dev_err(&master->dev,
1203 "failed to prepare transfer hardware\n");
Mark Brown49834de2013-07-28 14:47:02 +01001204
1205 if (master->auto_runtime_pm)
1206 pm_runtime_put(master->dev.parent);
Mark Brown764f2162016-08-09 17:45:33 +01001207 mutex_unlock(&master->io_mutex);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001208 return;
1209 }
1210 }
1211
Mark Brown56ec1972013-10-07 19:33:53 +01001212 trace_spi_message_start(master->cur_msg);
1213
Mark Brown2841a5f2013-10-05 00:23:12 +01001214 if (master->prepare_message) {
1215 ret = master->prepare_message(master, master->cur_msg);
1216 if (ret) {
1217 dev_err(&master->dev,
1218 "failed to prepare message: %d\n", ret);
1219 master->cur_msg->status = ret;
1220 spi_finalize_current_message(master);
Jon Hunter49023d22016-03-08 12:28:20 +00001221 goto out;
Mark Brown2841a5f2013-10-05 00:23:12 +01001222 }
1223 master->cur_msg_prepared = true;
1224 }
1225
Mark Brown99adef32014-01-16 12:22:43 +00001226 ret = spi_map_msg(master, master->cur_msg);
1227 if (ret) {
1228 master->cur_msg->status = ret;
1229 spi_finalize_current_message(master);
Jon Hunter49023d22016-03-08 12:28:20 +00001230 goto out;
Mark Brown99adef32014-01-16 12:22:43 +00001231 }
1232
Linus Walleijffbbdd212012-02-22 10:05:38 +01001233 ret = master->transfer_one_message(master, master->cur_msg);
1234 if (ret) {
1235 dev_err(&master->dev,
Geert Uytterhoeven1f802f82014-01-28 10:33:03 +01001236 "failed to transfer one message from queue\n");
Jon Hunter49023d22016-03-08 12:28:20 +00001237 goto out;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001238 }
Jon Hunter49023d22016-03-08 12:28:20 +00001239
1240out:
Mark Brownef4d96e2016-07-21 23:53:31 +01001241 mutex_unlock(&master->io_mutex);
Mark Brown62826972016-02-15 18:28:02 +00001242
1243 /* Prod the scheduler in case transfer_one() was busy waiting */
Jon Hunter49023d22016-03-08 12:28:20 +00001244 if (!ret)
1245 cond_resched();
Linus Walleijffbbdd212012-02-22 10:05:38 +01001246}
1247
Mark Brownfc9e0f72014-12-10 13:46:33 +00001248/**
1249 * spi_pump_messages - kthread work function which processes spi message queue
1250 * @work: pointer to kthread work struct contained in the master struct
1251 */
1252static void spi_pump_messages(struct kthread_work *work)
1253{
1254 struct spi_master *master =
1255 container_of(work, struct spi_master, pump_messages);
1256
Mark Brownef4d96e2016-07-21 23:53:31 +01001257 __spi_pump_messages(master, true);
Mark Brownfc9e0f72014-12-10 13:46:33 +00001258}
1259
Linus Walleijffbbdd212012-02-22 10:05:38 +01001260static int spi_init_queue(struct spi_master *master)
1261{
1262 struct sched_param param = { .sched_priority = MAX_RT_PRIO - 1 };
1263
Linus Walleijffbbdd212012-02-22 10:05:38 +01001264 master->running = false;
1265 master->busy = false;
1266
Petr Mladek39891442016-10-11 13:55:20 -07001267 kthread_init_worker(&master->kworker);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001268 master->kworker_task = kthread_run(kthread_worker_fn,
Kees Cookf1701682013-07-03 15:04:58 -07001269 &master->kworker, "%s",
Linus Walleijffbbdd212012-02-22 10:05:38 +01001270 dev_name(&master->dev));
1271 if (IS_ERR(master->kworker_task)) {
1272 dev_err(&master->dev, "failed to create message pump task\n");
Jarkko Nikula98a8f5a2014-12-04 11:02:25 +02001273 return PTR_ERR(master->kworker_task);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001274 }
Petr Mladek39891442016-10-11 13:55:20 -07001275 kthread_init_work(&master->pump_messages, spi_pump_messages);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001276
1277 /*
1278 * Master config will indicate if this controller should run the
1279 * message pump with high (realtime) priority to reduce the transfer
1280 * latency on the bus by minimising the delay between a transfer
1281 * request and the scheduling of the message pump thread. Without this
1282 * setting the message pump thread will remain at default priority.
1283 */
1284 if (master->rt) {
1285 dev_info(&master->dev,
1286 "will run message pump with realtime priority\n");
1287 sched_setscheduler(master->kworker_task, SCHED_FIFO, &param);
1288 }
1289
1290 return 0;
1291}
1292
1293/**
1294 * spi_get_next_queued_message() - called by driver to check for queued
1295 * messages
1296 * @master: the master to check for queued messages
1297 *
1298 * If there are more messages in the queue, the next message is returned from
1299 * this call.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001300 *
1301 * Return: the next message in the queue, else NULL if the queue is empty.
Linus Walleijffbbdd212012-02-22 10:05:38 +01001302 */
1303struct spi_message *spi_get_next_queued_message(struct spi_master *master)
1304{
1305 struct spi_message *next;
1306 unsigned long flags;
1307
1308 /* get a pointer to the next message, if any */
1309 spin_lock_irqsave(&master->queue_lock, flags);
Axel Lin1cfd97f2014-01-02 15:16:40 +08001310 next = list_first_entry_or_null(&master->queue, struct spi_message,
1311 queue);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001312 spin_unlock_irqrestore(&master->queue_lock, flags);
1313
1314 return next;
1315}
1316EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
1317
1318/**
1319 * spi_finalize_current_message() - the current message is complete
1320 * @master: the master to return the message to
1321 *
1322 * Called by the driver to notify the core that the message in the front of the
1323 * queue is complete and can be removed from the queue.
1324 */
1325void spi_finalize_current_message(struct spi_master *master)
1326{
1327 struct spi_message *mesg;
1328 unsigned long flags;
Mark Brown2841a5f2013-10-05 00:23:12 +01001329 int ret;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001330
1331 spin_lock_irqsave(&master->queue_lock, flags);
1332 mesg = master->cur_msg;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001333 spin_unlock_irqrestore(&master->queue_lock, flags);
1334
Mark Brown99adef32014-01-16 12:22:43 +00001335 spi_unmap_msg(master, mesg);
1336
Mark Brown2841a5f2013-10-05 00:23:12 +01001337 if (master->cur_msg_prepared && master->unprepare_message) {
1338 ret = master->unprepare_message(master, mesg);
1339 if (ret) {
1340 dev_err(&master->dev,
1341 "failed to unprepare message: %d\n", ret);
1342 }
1343 }
Uwe Kleine-König391949b2015-03-18 11:27:28 +01001344
Martin Sperl8e76ef82015-05-10 07:50:45 +00001345 spin_lock_irqsave(&master->queue_lock, flags);
1346 master->cur_msg = NULL;
Mark Brown2841a5f2013-10-05 00:23:12 +01001347 master->cur_msg_prepared = false;
Petr Mladek39891442016-10-11 13:55:20 -07001348 kthread_queue_work(&master->kworker, &master->pump_messages);
Martin Sperl8e76ef82015-05-10 07:50:45 +00001349 spin_unlock_irqrestore(&master->queue_lock, flags);
1350
1351 trace_spi_message_done(mesg);
Mark Brown2841a5f2013-10-05 00:23:12 +01001352
Linus Walleijffbbdd212012-02-22 10:05:38 +01001353 mesg->state = NULL;
1354 if (mesg->complete)
1355 mesg->complete(mesg->context);
1356}
1357EXPORT_SYMBOL_GPL(spi_finalize_current_message);
1358
1359static int spi_start_queue(struct spi_master *master)
1360{
1361 unsigned long flags;
1362
1363 spin_lock_irqsave(&master->queue_lock, flags);
1364
1365 if (master->running || master->busy) {
1366 spin_unlock_irqrestore(&master->queue_lock, flags);
1367 return -EBUSY;
1368 }
1369
1370 master->running = true;
1371 master->cur_msg = NULL;
1372 spin_unlock_irqrestore(&master->queue_lock, flags);
1373
Petr Mladek39891442016-10-11 13:55:20 -07001374 kthread_queue_work(&master->kworker, &master->pump_messages);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001375
1376 return 0;
1377}
1378
1379static int spi_stop_queue(struct spi_master *master)
1380{
1381 unsigned long flags;
1382 unsigned limit = 500;
1383 int ret = 0;
1384
1385 spin_lock_irqsave(&master->queue_lock, flags);
1386
1387 /*
1388 * This is a bit lame, but is optimized for the common execution path.
1389 * A wait_queue on the master->busy could be used, but then the common
1390 * execution path (pump_messages) would be required to call wake_up or
1391 * friends on every SPI message. Do this instead.
1392 */
1393 while ((!list_empty(&master->queue) || master->busy) && limit--) {
1394 spin_unlock_irqrestore(&master->queue_lock, flags);
Axel Linf97b26b2014-02-21 09:15:18 +08001395 usleep_range(10000, 11000);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001396 spin_lock_irqsave(&master->queue_lock, flags);
1397 }
1398
1399 if (!list_empty(&master->queue) || master->busy)
1400 ret = -EBUSY;
1401 else
1402 master->running = false;
1403
1404 spin_unlock_irqrestore(&master->queue_lock, flags);
1405
1406 if (ret) {
1407 dev_warn(&master->dev,
1408 "could not stop message queue\n");
1409 return ret;
1410 }
1411 return ret;
1412}
1413
1414static int spi_destroy_queue(struct spi_master *master)
1415{
1416 int ret;
1417
1418 ret = spi_stop_queue(master);
1419
1420 /*
Petr Mladek39891442016-10-11 13:55:20 -07001421 * kthread_flush_worker will block until all work is done.
Linus Walleijffbbdd212012-02-22 10:05:38 +01001422 * If the reason that stop_queue timed out is that the work will never
1423 * finish, then it does no good to call flush/stop thread, so
1424 * return anyway.
1425 */
1426 if (ret) {
1427 dev_err(&master->dev, "problem destroying queue\n");
1428 return ret;
1429 }
1430
Petr Mladek39891442016-10-11 13:55:20 -07001431 kthread_flush_worker(&master->kworker);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001432 kthread_stop(master->kworker_task);
1433
1434 return 0;
1435}
1436
Mark Brown0461a412014-12-09 21:38:05 +00001437static int __spi_queued_transfer(struct spi_device *spi,
1438 struct spi_message *msg,
1439 bool need_pump)
Linus Walleijffbbdd212012-02-22 10:05:38 +01001440{
1441 struct spi_master *master = spi->master;
1442 unsigned long flags;
1443
1444 spin_lock_irqsave(&master->queue_lock, flags);
1445
1446 if (!master->running) {
1447 spin_unlock_irqrestore(&master->queue_lock, flags);
1448 return -ESHUTDOWN;
1449 }
1450 msg->actual_length = 0;
1451 msg->status = -EINPROGRESS;
1452
1453 list_add_tail(&msg->queue, &master->queue);
Mark Brown0461a412014-12-09 21:38:05 +00001454 if (!master->busy && need_pump)
Petr Mladek39891442016-10-11 13:55:20 -07001455 kthread_queue_work(&master->kworker, &master->pump_messages);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001456
1457 spin_unlock_irqrestore(&master->queue_lock, flags);
1458 return 0;
1459}
1460
Mark Brown0461a412014-12-09 21:38:05 +00001461/**
1462 * spi_queued_transfer - transfer function for queued transfers
1463 * @spi: spi device which is requesting transfer
1464 * @msg: spi message which is to handled is queued to driver queue
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001465 *
1466 * Return: zero on success, else a negative error code.
Mark Brown0461a412014-12-09 21:38:05 +00001467 */
1468static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
1469{
1470 return __spi_queued_transfer(spi, msg, true);
1471}
1472
Linus Walleijffbbdd212012-02-22 10:05:38 +01001473static int spi_master_initialize_queue(struct spi_master *master)
1474{
1475 int ret;
1476
Linus Walleijffbbdd212012-02-22 10:05:38 +01001477 master->transfer = spi_queued_transfer;
Mark Brownb1589352013-10-05 11:50:40 +01001478 if (!master->transfer_one_message)
1479 master->transfer_one_message = spi_transfer_one_message;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001480
1481 /* Initialize and start queue */
1482 ret = spi_init_queue(master);
1483 if (ret) {
1484 dev_err(&master->dev, "problem initializing queue\n");
1485 goto err_init_queue;
1486 }
Mark Brownc3676d52014-05-01 10:47:52 -07001487 master->queued = true;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001488 ret = spi_start_queue(master);
1489 if (ret) {
1490 dev_err(&master->dev, "problem starting queue\n");
1491 goto err_start_queue;
1492 }
1493
1494 return 0;
1495
1496err_start_queue:
Linus Walleijffbbdd212012-02-22 10:05:38 +01001497 spi_destroy_queue(master);
Mark Brownc3676d52014-05-01 10:47:52 -07001498err_init_queue:
Linus Walleijffbbdd212012-02-22 10:05:38 +01001499 return ret;
1500}
1501
1502/*-------------------------------------------------------------------------*/
1503
Andreas Larsson7cb94362012-12-04 15:09:38 +01001504#if defined(CONFIG_OF)
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001505static struct spi_device *
1506of_register_spi_device(struct spi_master *master, struct device_node *nc)
1507{
1508 struct spi_device *spi;
1509 int rc;
1510 u32 value;
1511
1512 /* Alloc an spi_device */
1513 spi = spi_alloc_device(master);
1514 if (!spi) {
1515 dev_err(&master->dev, "spi_device alloc error for %s\n",
1516 nc->full_name);
1517 rc = -ENOMEM;
1518 goto err_out;
1519 }
1520
1521 /* Select device driver */
1522 rc = of_modalias_node(nc, spi->modalias,
1523 sizeof(spi->modalias));
1524 if (rc < 0) {
1525 dev_err(&master->dev, "cannot find modalias for %s\n",
1526 nc->full_name);
1527 goto err_out;
1528 }
1529
1530 /* Device address */
1531 rc = of_property_read_u32(nc, "reg", &value);
1532 if (rc) {
1533 dev_err(&master->dev, "%s has no valid 'reg' property (%d)\n",
1534 nc->full_name, rc);
1535 goto err_out;
1536 }
1537 spi->chip_select = value;
1538
1539 /* Mode (clock phase/polarity/etc.) */
1540 if (of_find_property(nc, "spi-cpha", NULL))
1541 spi->mode |= SPI_CPHA;
1542 if (of_find_property(nc, "spi-cpol", NULL))
1543 spi->mode |= SPI_CPOL;
1544 if (of_find_property(nc, "spi-cs-high", NULL))
1545 spi->mode |= SPI_CS_HIGH;
1546 if (of_find_property(nc, "spi-3wire", NULL))
1547 spi->mode |= SPI_3WIRE;
1548 if (of_find_property(nc, "spi-lsb-first", NULL))
1549 spi->mode |= SPI_LSB_FIRST;
1550
1551 /* Device DUAL/QUAD mode */
1552 if (!of_property_read_u32(nc, "spi-tx-bus-width", &value)) {
1553 switch (value) {
1554 case 1:
1555 break;
1556 case 2:
1557 spi->mode |= SPI_TX_DUAL;
1558 break;
1559 case 4:
1560 spi->mode |= SPI_TX_QUAD;
1561 break;
1562 default:
1563 dev_warn(&master->dev,
1564 "spi-tx-bus-width %d not supported\n",
1565 value);
1566 break;
1567 }
1568 }
1569
1570 if (!of_property_read_u32(nc, "spi-rx-bus-width", &value)) {
1571 switch (value) {
1572 case 1:
1573 break;
1574 case 2:
1575 spi->mode |= SPI_RX_DUAL;
1576 break;
1577 case 4:
1578 spi->mode |= SPI_RX_QUAD;
1579 break;
1580 default:
1581 dev_warn(&master->dev,
1582 "spi-rx-bus-width %d not supported\n",
1583 value);
1584 break;
1585 }
1586 }
1587
1588 /* Device speed */
1589 rc = of_property_read_u32(nc, "spi-max-frequency", &value);
1590 if (rc) {
1591 dev_err(&master->dev, "%s has no valid 'spi-max-frequency' property (%d)\n",
1592 nc->full_name, rc);
1593 goto err_out;
1594 }
1595 spi->max_speed_hz = value;
1596
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001597 /* Store a pointer to the node in the device structure */
1598 of_node_get(nc);
1599 spi->dev.of_node = nc;
1600
1601 /* Register the new device */
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001602 rc = spi_add_device(spi);
1603 if (rc) {
1604 dev_err(&master->dev, "spi_device register error %s\n",
1605 nc->full_name);
1606 goto err_out;
1607 }
1608
1609 return spi;
1610
1611err_out:
1612 spi_dev_put(spi);
1613 return ERR_PTR(rc);
1614}
1615
Grant Likelyd57a4282012-04-07 14:16:53 -06001616/**
1617 * of_register_spi_devices() - Register child devices onto the SPI bus
1618 * @master: Pointer to spi_master device
1619 *
1620 * Registers an spi_device for each child node of master node which has a 'reg'
1621 * property.
1622 */
1623static void of_register_spi_devices(struct spi_master *master)
1624{
1625 struct spi_device *spi;
1626 struct device_node *nc;
Grant Likelyd57a4282012-04-07 14:16:53 -06001627
1628 if (!master->dev.of_node)
1629 return;
1630
Alexander Sverdlinf3b61592012-11-29 08:59:29 +01001631 for_each_available_child_of_node(master->dev.of_node, nc) {
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +01001632 if (of_node_test_and_set_flag(nc, OF_POPULATED))
1633 continue;
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001634 spi = of_register_spi_device(master, nc);
Ralf Ramsauere0af98a2016-10-17 15:59:56 +02001635 if (IS_ERR(spi)) {
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001636 dev_warn(&master->dev, "Failed to create SPI device for %s\n",
Grant Likelyd57a4282012-04-07 14:16:53 -06001637 nc->full_name);
Ralf Ramsauere0af98a2016-10-17 15:59:56 +02001638 of_node_clear_flag(nc, OF_POPULATED);
1639 }
Grant Likelyd57a4282012-04-07 14:16:53 -06001640 }
1641}
1642#else
1643static void of_register_spi_devices(struct spi_master *master) { }
1644#endif
1645
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001646#ifdef CONFIG_ACPI
1647static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
1648{
1649 struct spi_device *spi = data;
Mika Westerberga0a90712016-02-08 17:14:28 +02001650 struct spi_master *master = spi->master;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001651
1652 if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
1653 struct acpi_resource_spi_serialbus *sb;
1654
1655 sb = &ares->data.spi_serial_bus;
1656 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
Mika Westerberga0a90712016-02-08 17:14:28 +02001657 /*
1658 * ACPI DeviceSelection numbering is handled by the
1659 * host controller driver in Windows and can vary
1660 * from driver to driver. In Linux we always expect
1661 * 0 .. max - 1 so we need to ask the driver to
1662 * translate between the two schemes.
1663 */
1664 if (master->fw_translate_cs) {
1665 int cs = master->fw_translate_cs(master,
1666 sb->device_selection);
1667 if (cs < 0)
1668 return cs;
1669 spi->chip_select = cs;
1670 } else {
1671 spi->chip_select = sb->device_selection;
1672 }
1673
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001674 spi->max_speed_hz = sb->connection_speed;
1675
1676 if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
1677 spi->mode |= SPI_CPHA;
1678 if (sb->clock_polarity == ACPI_SPI_START_HIGH)
1679 spi->mode |= SPI_CPOL;
1680 if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
1681 spi->mode |= SPI_CS_HIGH;
1682 }
1683 } else if (spi->irq < 0) {
1684 struct resource r;
1685
1686 if (acpi_dev_resource_interrupt(ares, 0, &r))
1687 spi->irq = r.start;
1688 }
1689
1690 /* Always tell the ACPI core to skip this resource */
1691 return 1;
1692}
1693
Octavian Purdila7f244672016-07-08 19:13:11 +03001694static acpi_status acpi_register_spi_device(struct spi_master *master,
1695 struct acpi_device *adev)
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001696{
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001697 struct list_head resource_list;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001698 struct spi_device *spi;
1699 int ret;
1700
Octavian Purdila7f244672016-07-08 19:13:11 +03001701 if (acpi_bus_get_status(adev) || !adev->status.present ||
1702 acpi_device_enumerated(adev))
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001703 return AE_OK;
1704
1705 spi = spi_alloc_device(master);
1706 if (!spi) {
1707 dev_err(&master->dev, "failed to allocate SPI device for %s\n",
1708 dev_name(&adev->dev));
1709 return AE_NO_MEMORY;
1710 }
1711
Rafael J. Wysocki7b199812013-11-11 22:41:56 +01001712 ACPI_COMPANION_SET(&spi->dev, adev);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001713 spi->irq = -1;
1714
1715 INIT_LIST_HEAD(&resource_list);
1716 ret = acpi_dev_get_resources(adev, &resource_list,
1717 acpi_spi_add_resource, spi);
1718 acpi_dev_free_resource_list(&resource_list);
1719
1720 if (ret < 0 || !spi->max_speed_hz) {
1721 spi_dev_put(spi);
1722 return AE_OK;
1723 }
1724
Dan O'Donovan0c6543f2017-02-05 16:30:14 +00001725 acpi_set_modalias(adev, acpi_device_hid(adev), spi->modalias,
1726 sizeof(spi->modalias));
1727
Christophe RICARD33ada672015-12-23 23:25:35 +01001728 if (spi->irq < 0)
1729 spi->irq = acpi_dev_gpio_irq_get(adev, 0);
1730
Octavian Purdila7f244672016-07-08 19:13:11 +03001731 acpi_device_set_enumerated(adev);
1732
Mika Westerberg33cf00e2013-10-10 13:28:48 +03001733 adev->power.flags.ignore_parent = true;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001734 if (spi_add_device(spi)) {
Mika Westerberg33cf00e2013-10-10 13:28:48 +03001735 adev->power.flags.ignore_parent = false;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001736 dev_err(&master->dev, "failed to add SPI device %s from ACPI\n",
1737 dev_name(&adev->dev));
1738 spi_dev_put(spi);
1739 }
1740
1741 return AE_OK;
1742}
1743
Octavian Purdila7f244672016-07-08 19:13:11 +03001744static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
1745 void *data, void **return_value)
1746{
1747 struct spi_master *master = data;
1748 struct acpi_device *adev;
1749
1750 if (acpi_bus_get_device(handle, &adev))
1751 return AE_OK;
1752
1753 return acpi_register_spi_device(master, adev);
1754}
1755
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001756static void acpi_register_spi_devices(struct spi_master *master)
1757{
1758 acpi_status status;
1759 acpi_handle handle;
1760
Rafael J. Wysocki29896172013-04-01 00:21:08 +00001761 handle = ACPI_HANDLE(master->dev.parent);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001762 if (!handle)
1763 return;
1764
1765 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
1766 acpi_spi_add_device, NULL,
1767 master, NULL);
1768 if (ACPI_FAILURE(status))
1769 dev_warn(&master->dev, "failed to enumerate SPI slaves\n");
1770}
1771#else
1772static inline void acpi_register_spi_devices(struct spi_master *master) {}
1773#endif /* CONFIG_ACPI */
1774
Tony Jones49dce682007-10-16 01:27:48 -07001775static void spi_master_release(struct device *dev)
David Brownell8ae12a02006-01-08 13:34:19 -08001776{
1777 struct spi_master *master;
1778
Tony Jones49dce682007-10-16 01:27:48 -07001779 master = container_of(dev, struct spi_master, dev);
David Brownell8ae12a02006-01-08 13:34:19 -08001780 kfree(master);
1781}
1782
1783static struct class spi_master_class = {
1784 .name = "spi_master",
1785 .owner = THIS_MODULE,
Tony Jones49dce682007-10-16 01:27:48 -07001786 .dev_release = spi_master_release,
Martin Sperleca2ebc2015-06-22 13:00:36 +00001787 .dev_groups = spi_master_groups,
David Brownell8ae12a02006-01-08 13:34:19 -08001788};
1789
1790
1791/**
1792 * spi_alloc_master - allocate SPI master controller
1793 * @dev: the controller, possibly using the platform_bus
David Brownell33e34dc2007-05-08 00:32:21 -07001794 * @size: how much zeroed driver-private data to allocate; the pointer to this
Tony Jones49dce682007-10-16 01:27:48 -07001795 * memory is in the driver_data field of the returned device,
David Brownell0c8684612006-01-08 13:34:25 -08001796 * accessible with spi_master_get_devdata().
David Brownell33e34dc2007-05-08 00:32:21 -07001797 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001798 *
1799 * This call is used only by SPI master controller drivers, which are the
1800 * only ones directly touching chip registers. It's how they allocate
dmitry pervushinba1a0512006-05-20 15:00:14 -07001801 * an spi_master structure, prior to calling spi_register_master().
David Brownell8ae12a02006-01-08 13:34:19 -08001802 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001803 * This must be called from context that can sleep.
David Brownell8ae12a02006-01-08 13:34:19 -08001804 *
1805 * The caller is responsible for assigning the bus number and initializing
dmitry pervushinba1a0512006-05-20 15:00:14 -07001806 * the master's methods before calling spi_register_master(); and (after errors
Guenter Roecka394d632015-09-06 01:46:54 +03001807 * adding the device) calling spi_master_put() to prevent a memory leak.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001808 *
1809 * Return: the SPI master structure on success, else NULL.
David Brownell8ae12a02006-01-08 13:34:19 -08001810 */
Adrian Bunke9d5a462007-03-26 21:32:23 -08001811struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
David Brownell8ae12a02006-01-08 13:34:19 -08001812{
1813 struct spi_master *master;
1814
David Brownell0c8684612006-01-08 13:34:25 -08001815 if (!dev)
1816 return NULL;
1817
Jingoo Han5fe5f052013-10-14 10:31:51 +09001818 master = kzalloc(size + sizeof(*master), GFP_KERNEL);
David Brownell8ae12a02006-01-08 13:34:19 -08001819 if (!master)
1820 return NULL;
1821
Tony Jones49dce682007-10-16 01:27:48 -07001822 device_initialize(&master->dev);
Grant Likely1e8a52e2012-05-19 23:42:08 -06001823 master->bus_num = -1;
1824 master->num_chipselect = 1;
Tony Jones49dce682007-10-16 01:27:48 -07001825 master->dev.class = &spi_master_class;
Johan Hovold157f38f2015-12-14 16:16:19 +01001826 master->dev.parent = dev;
Linus Walleijd7e2ee22016-04-11 13:51:03 +02001827 pm_suspend_ignore_children(&master->dev, true);
David Brownell0c8684612006-01-08 13:34:25 -08001828 spi_master_set_devdata(master, &master[1]);
David Brownell8ae12a02006-01-08 13:34:19 -08001829
1830 return master;
1831}
1832EXPORT_SYMBOL_GPL(spi_alloc_master);
1833
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001834#ifdef CONFIG_OF
1835static int of_spi_register_master(struct spi_master *master)
1836{
Grant Likelye80beb22013-02-12 17:48:37 +00001837 int nb, i, *cs;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001838 struct device_node *np = master->dev.of_node;
1839
1840 if (!np)
1841 return 0;
1842
1843 nb = of_gpio_named_count(np, "cs-gpios");
Jingoo Han5fe5f052013-10-14 10:31:51 +09001844 master->num_chipselect = max_t(int, nb, master->num_chipselect);
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001845
Andreas Larsson8ec5d842013-02-13 14:23:24 +01001846 /* Return error only for an incorrectly formed cs-gpios property */
1847 if (nb == 0 || nb == -ENOENT)
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001848 return 0;
Andreas Larsson8ec5d842013-02-13 14:23:24 +01001849 else if (nb < 0)
1850 return nb;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001851
1852 cs = devm_kzalloc(&master->dev,
1853 sizeof(int) * master->num_chipselect,
1854 GFP_KERNEL);
1855 master->cs_gpios = cs;
1856
1857 if (!master->cs_gpios)
1858 return -ENOMEM;
1859
Andreas Larsson0da83bb2013-01-29 15:53:40 +01001860 for (i = 0; i < master->num_chipselect; i++)
Andreas Larsson446411e2013-02-13 14:20:25 +01001861 cs[i] = -ENOENT;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001862
1863 for (i = 0; i < nb; i++)
1864 cs[i] = of_get_named_gpio(np, "cs-gpios", i);
1865
1866 return 0;
1867}
1868#else
1869static int of_spi_register_master(struct spi_master *master)
1870{
1871 return 0;
1872}
1873#endif
1874
David Brownell8ae12a02006-01-08 13:34:19 -08001875/**
1876 * spi_register_master - register SPI master controller
1877 * @master: initialized master, originally from spi_alloc_master()
David Brownell33e34dc2007-05-08 00:32:21 -07001878 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001879 *
1880 * SPI master controllers connect to their drivers using some non-SPI bus,
1881 * such as the platform bus. The final stage of probe() in that code
1882 * includes calling spi_register_master() to hook up to this SPI bus glue.
1883 *
1884 * SPI controllers use board specific (often SOC specific) bus numbers,
1885 * and board-specific addressing for SPI devices combines those numbers
1886 * with chip select numbers. Since SPI does not directly support dynamic
1887 * device identification, boards need configuration tables telling which
1888 * chip is at which address.
1889 *
1890 * This must be called from context that can sleep. It returns zero on
1891 * success, else a negative error code (dropping the master's refcount).
David Brownell0c8684612006-01-08 13:34:25 -08001892 * After a successful return, the caller is responsible for calling
1893 * spi_unregister_master().
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001894 *
1895 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08001896 */
Adrian Bunke9d5a462007-03-26 21:32:23 -08001897int spi_register_master(struct spi_master *master)
David Brownell8ae12a02006-01-08 13:34:19 -08001898{
David Brownelle44a45a2007-06-03 13:50:40 -07001899 static atomic_t dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
Tony Jones49dce682007-10-16 01:27:48 -07001900 struct device *dev = master->dev.parent;
Feng Tang2b9603a2010-08-02 15:52:15 +08001901 struct boardinfo *bi;
David Brownell8ae12a02006-01-08 13:34:19 -08001902 int status = -ENODEV;
1903 int dynamic = 0;
1904
David Brownell0c8684612006-01-08 13:34:25 -08001905 if (!dev)
1906 return -ENODEV;
1907
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001908 status = of_spi_register_master(master);
1909 if (status)
1910 return status;
1911
David Brownell082c8cb2007-07-31 00:39:45 -07001912 /* even if it's just one always-selected device, there must
1913 * be at least one chipselect
1914 */
1915 if (master->num_chipselect == 0)
1916 return -EINVAL;
1917
Grant Likelybb297852012-12-21 19:32:09 +00001918 if ((master->bus_num < 0) && master->dev.of_node)
1919 master->bus_num = of_alias_get_id(master->dev.of_node, "spi");
1920
David Brownell8ae12a02006-01-08 13:34:19 -08001921 /* convention: dynamically assigned bus IDs count down from the max */
David Brownella020ed72006-04-03 15:49:04 -07001922 if (master->bus_num < 0) {
David Brownell082c8cb2007-07-31 00:39:45 -07001923 /* FIXME switch to an IDR based scheme, something like
1924 * I2C now uses, so we can't run out of "dynamic" IDs
1925 */
David Brownell8ae12a02006-01-08 13:34:19 -08001926 master->bus_num = atomic_dec_return(&dyn_bus_id);
David Brownellb8852442006-01-08 13:34:23 -08001927 dynamic = 1;
David Brownell8ae12a02006-01-08 13:34:19 -08001928 }
1929
Mark Brown5424d432014-12-10 17:40:53 +00001930 INIT_LIST_HEAD(&master->queue);
1931 spin_lock_init(&master->queue_lock);
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001932 spin_lock_init(&master->bus_lock_spinlock);
1933 mutex_init(&master->bus_lock_mutex);
Mark Brownef4d96e2016-07-21 23:53:31 +01001934 mutex_init(&master->io_mutex);
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001935 master->bus_lock_flag = 0;
Mark Brownb1589352013-10-05 11:50:40 +01001936 init_completion(&master->xfer_completion);
Mark Brown6ad45a22014-02-02 13:47:47 +00001937 if (!master->max_dma_len)
1938 master->max_dma_len = INT_MAX;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001939
David Brownell8ae12a02006-01-08 13:34:19 -08001940 /* register the device, then userspace will see it.
1941 * registration fails if the bus ID is in use.
1942 */
Kay Sievers35f74fc2009-01-06 10:44:37 -08001943 dev_set_name(&master->dev, "spi%u", master->bus_num);
Tony Jones49dce682007-10-16 01:27:48 -07001944 status = device_add(&master->dev);
David Brownellb8852442006-01-08 13:34:23 -08001945 if (status < 0)
David Brownell8ae12a02006-01-08 13:34:19 -08001946 goto done;
Kay Sievers35f74fc2009-01-06 10:44:37 -08001947 dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
David Brownell8ae12a02006-01-08 13:34:19 -08001948 dynamic ? " (dynamic)" : "");
1949
Linus Walleijffbbdd212012-02-22 10:05:38 +01001950 /* If we're using a queued driver, start the queue */
1951 if (master->transfer)
1952 dev_info(dev, "master is unqueued, this is deprecated\n");
1953 else {
1954 status = spi_master_initialize_queue(master);
1955 if (status) {
Axel Line93b0722013-08-31 20:25:52 +08001956 device_del(&master->dev);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001957 goto done;
1958 }
1959 }
Martin Sperleca2ebc2015-06-22 13:00:36 +00001960 /* add statistics */
1961 spin_lock_init(&master->statistics.lock);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001962
Feng Tang2b9603a2010-08-02 15:52:15 +08001963 mutex_lock(&board_lock);
1964 list_add_tail(&master->list, &spi_master_list);
1965 list_for_each_entry(bi, &board_list, list)
1966 spi_match_master_to_boardinfo(master, &bi->board_info);
1967 mutex_unlock(&board_lock);
1968
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001969 /* Register devices from the device tree and ACPI */
Anatolij Gustschin12b15e82010-07-27 22:35:58 +02001970 of_register_spi_devices(master);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001971 acpi_register_spi_devices(master);
David Brownell8ae12a02006-01-08 13:34:19 -08001972done:
1973 return status;
1974}
1975EXPORT_SYMBOL_GPL(spi_register_master);
1976
Mark Brown666d5b42013-08-31 18:50:52 +01001977static void devm_spi_unregister(struct device *dev, void *res)
1978{
1979 spi_unregister_master(*(struct spi_master **)res);
1980}
1981
1982/**
1983 * dev_spi_register_master - register managed SPI master controller
1984 * @dev: device managing SPI master
1985 * @master: initialized master, originally from spi_alloc_master()
1986 * Context: can sleep
1987 *
1988 * Register a SPI device as with spi_register_master() which will
1989 * automatically be unregister
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001990 *
1991 * Return: zero on success, else a negative error code.
Mark Brown666d5b42013-08-31 18:50:52 +01001992 */
1993int devm_spi_register_master(struct device *dev, struct spi_master *master)
1994{
1995 struct spi_master **ptr;
1996 int ret;
1997
1998 ptr = devres_alloc(devm_spi_unregister, sizeof(*ptr), GFP_KERNEL);
1999 if (!ptr)
2000 return -ENOMEM;
2001
2002 ret = spi_register_master(master);
Stephen Warren4b928942013-11-21 16:11:15 -07002003 if (!ret) {
Mark Brown666d5b42013-08-31 18:50:52 +01002004 *ptr = master;
2005 devres_add(dev, ptr);
2006 } else {
2007 devres_free(ptr);
2008 }
2009
2010 return ret;
2011}
2012EXPORT_SYMBOL_GPL(devm_spi_register_master);
2013
David Lamparter34860082010-08-30 23:54:17 +02002014static int __unregister(struct device *dev, void *null)
David Brownell8ae12a02006-01-08 13:34:19 -08002015{
David Lamparter34860082010-08-30 23:54:17 +02002016 spi_unregister_device(to_spi_device(dev));
David Brownell8ae12a02006-01-08 13:34:19 -08002017 return 0;
2018}
2019
2020/**
2021 * spi_unregister_master - unregister SPI master controller
2022 * @master: the master being unregistered
David Brownell33e34dc2007-05-08 00:32:21 -07002023 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08002024 *
2025 * This call is used only by SPI master controller drivers, which are the
2026 * only ones directly touching chip registers.
2027 *
2028 * This must be called from context that can sleep.
2029 */
2030void spi_unregister_master(struct spi_master *master)
2031{
Jeff Garzik89fc9a12006-12-06 20:35:35 -08002032 int dummy;
2033
Linus Walleijffbbdd212012-02-22 10:05:38 +01002034 if (master->queued) {
2035 if (spi_destroy_queue(master))
2036 dev_err(&master->dev, "queue remove failed\n");
2037 }
2038
Feng Tang2b9603a2010-08-02 15:52:15 +08002039 mutex_lock(&board_lock);
2040 list_del(&master->list);
2041 mutex_unlock(&board_lock);
2042
Sebastian Andrzej Siewior97dbf372010-12-21 17:24:31 -08002043 dummy = device_for_each_child(&master->dev, NULL, __unregister);
Tony Jones49dce682007-10-16 01:27:48 -07002044 device_unregister(&master->dev);
David Brownell8ae12a02006-01-08 13:34:19 -08002045}
2046EXPORT_SYMBOL_GPL(spi_unregister_master);
2047
Linus Walleijffbbdd212012-02-22 10:05:38 +01002048int spi_master_suspend(struct spi_master *master)
2049{
2050 int ret;
2051
2052 /* Basically no-ops for non-queued masters */
2053 if (!master->queued)
2054 return 0;
2055
2056 ret = spi_stop_queue(master);
2057 if (ret)
2058 dev_err(&master->dev, "queue stop failed\n");
2059
2060 return ret;
2061}
2062EXPORT_SYMBOL_GPL(spi_master_suspend);
2063
2064int spi_master_resume(struct spi_master *master)
2065{
2066 int ret;
2067
2068 if (!master->queued)
2069 return 0;
2070
2071 ret = spi_start_queue(master);
2072 if (ret)
2073 dev_err(&master->dev, "queue restart failed\n");
2074
2075 return ret;
2076}
2077EXPORT_SYMBOL_GPL(spi_master_resume);
2078
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002079static int __spi_master_match(struct device *dev, const void *data)
Dave Young5ed2c832008-01-22 15:14:18 +08002080{
2081 struct spi_master *m;
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002082 const u16 *bus_num = data;
Dave Young5ed2c832008-01-22 15:14:18 +08002083
2084 m = container_of(dev, struct spi_master, dev);
2085 return m->bus_num == *bus_num;
2086}
2087
David Brownell8ae12a02006-01-08 13:34:19 -08002088/**
2089 * spi_busnum_to_master - look up master associated with bus_num
2090 * @bus_num: the master's bus number
David Brownell33e34dc2007-05-08 00:32:21 -07002091 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08002092 *
2093 * This call may be used with devices that are registered after
2094 * arch init time. It returns a refcounted pointer to the relevant
2095 * spi_master (which the caller must release), or NULL if there is
2096 * no such master registered.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002097 *
2098 * Return: the SPI master structure on success, else NULL.
David Brownell8ae12a02006-01-08 13:34:19 -08002099 */
2100struct spi_master *spi_busnum_to_master(u16 bus_num)
2101{
Tony Jones49dce682007-10-16 01:27:48 -07002102 struct device *dev;
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -08002103 struct spi_master *master = NULL;
David Brownell8ae12a02006-01-08 13:34:19 -08002104
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04002105 dev = class_find_device(&spi_master_class, NULL, &bus_num,
Dave Young5ed2c832008-01-22 15:14:18 +08002106 __spi_master_match);
2107 if (dev)
2108 master = container_of(dev, struct spi_master, dev);
2109 /* reference got in class_find_device */
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -08002110 return master;
David Brownell8ae12a02006-01-08 13:34:19 -08002111}
2112EXPORT_SYMBOL_GPL(spi_busnum_to_master);
2113
Martin Sperld780c372015-12-14 15:20:18 +00002114/*-------------------------------------------------------------------------*/
2115
2116/* Core methods for SPI resource management */
2117
2118/**
2119 * spi_res_alloc - allocate a spi resource that is life-cycle managed
2120 * during the processing of a spi_message while using
2121 * spi_transfer_one
2122 * @spi: the spi device for which we allocate memory
2123 * @release: the release code to execute for this resource
2124 * @size: size to alloc and return
2125 * @gfp: GFP allocation flags
2126 *
2127 * Return: the pointer to the allocated data
2128 *
2129 * This may get enhanced in the future to allocate from a memory pool
2130 * of the @spi_device or @spi_master to avoid repeated allocations.
2131 */
2132void *spi_res_alloc(struct spi_device *spi,
2133 spi_res_release_t release,
2134 size_t size, gfp_t gfp)
2135{
2136 struct spi_res *sres;
2137
2138 sres = kzalloc(sizeof(*sres) + size, gfp);
2139 if (!sres)
2140 return NULL;
2141
2142 INIT_LIST_HEAD(&sres->entry);
2143 sres->release = release;
2144
2145 return sres->data;
2146}
2147EXPORT_SYMBOL_GPL(spi_res_alloc);
2148
2149/**
2150 * spi_res_free - free an spi resource
2151 * @res: pointer to the custom data of a resource
2152 *
2153 */
2154void spi_res_free(void *res)
2155{
2156 struct spi_res *sres = container_of(res, struct spi_res, data);
2157
2158 if (!res)
2159 return;
2160
2161 WARN_ON(!list_empty(&sres->entry));
2162 kfree(sres);
2163}
2164EXPORT_SYMBOL_GPL(spi_res_free);
2165
2166/**
2167 * spi_res_add - add a spi_res to the spi_message
2168 * @message: the spi message
2169 * @res: the spi_resource
2170 */
2171void spi_res_add(struct spi_message *message, void *res)
2172{
2173 struct spi_res *sres = container_of(res, struct spi_res, data);
2174
2175 WARN_ON(!list_empty(&sres->entry));
2176 list_add_tail(&sres->entry, &message->resources);
2177}
2178EXPORT_SYMBOL_GPL(spi_res_add);
2179
2180/**
2181 * spi_res_release - release all spi resources for this message
2182 * @master: the @spi_master
2183 * @message: the @spi_message
2184 */
2185void spi_res_release(struct spi_master *master,
2186 struct spi_message *message)
2187{
2188 struct spi_res *res;
2189
2190 while (!list_empty(&message->resources)) {
2191 res = list_last_entry(&message->resources,
2192 struct spi_res, entry);
2193
2194 if (res->release)
2195 res->release(master, message, res->data);
2196
2197 list_del(&res->entry);
2198
2199 kfree(res);
2200 }
2201}
2202EXPORT_SYMBOL_GPL(spi_res_release);
David Brownell8ae12a02006-01-08 13:34:19 -08002203
2204/*-------------------------------------------------------------------------*/
2205
Martin Sperl523baf5a2015-12-14 15:20:19 +00002206/* Core methods for spi_message alterations */
2207
2208static void __spi_replace_transfers_release(struct spi_master *master,
2209 struct spi_message *msg,
2210 void *res)
2211{
2212 struct spi_replaced_transfers *rxfer = res;
2213 size_t i;
2214
2215 /* call extra callback if requested */
2216 if (rxfer->release)
2217 rxfer->release(master, msg, res);
2218
2219 /* insert replaced transfers back into the message */
2220 list_splice(&rxfer->replaced_transfers, rxfer->replaced_after);
2221
2222 /* remove the formerly inserted entries */
2223 for (i = 0; i < rxfer->inserted; i++)
2224 list_del(&rxfer->inserted_transfers[i].transfer_list);
2225}
2226
2227/**
2228 * spi_replace_transfers - replace transfers with several transfers
2229 * and register change with spi_message.resources
2230 * @msg: the spi_message we work upon
2231 * @xfer_first: the first spi_transfer we want to replace
2232 * @remove: number of transfers to remove
2233 * @insert: the number of transfers we want to insert instead
2234 * @release: extra release code necessary in some circumstances
2235 * @extradatasize: extra data to allocate (with alignment guarantees
2236 * of struct @spi_transfer)
Martin Sperl05885392016-02-18 15:53:11 +00002237 * @gfp: gfp flags
Martin Sperl523baf5a2015-12-14 15:20:19 +00002238 *
2239 * Returns: pointer to @spi_replaced_transfers,
2240 * PTR_ERR(...) in case of errors.
2241 */
2242struct spi_replaced_transfers *spi_replace_transfers(
2243 struct spi_message *msg,
2244 struct spi_transfer *xfer_first,
2245 size_t remove,
2246 size_t insert,
2247 spi_replaced_release_t release,
2248 size_t extradatasize,
2249 gfp_t gfp)
2250{
2251 struct spi_replaced_transfers *rxfer;
2252 struct spi_transfer *xfer;
2253 size_t i;
2254
2255 /* allocate the structure using spi_res */
2256 rxfer = spi_res_alloc(msg->spi, __spi_replace_transfers_release,
2257 insert * sizeof(struct spi_transfer)
2258 + sizeof(struct spi_replaced_transfers)
2259 + extradatasize,
2260 gfp);
2261 if (!rxfer)
2262 return ERR_PTR(-ENOMEM);
2263
2264 /* the release code to invoke before running the generic release */
2265 rxfer->release = release;
2266
2267 /* assign extradata */
2268 if (extradatasize)
2269 rxfer->extradata =
2270 &rxfer->inserted_transfers[insert];
2271
2272 /* init the replaced_transfers list */
2273 INIT_LIST_HEAD(&rxfer->replaced_transfers);
2274
2275 /* assign the list_entry after which we should reinsert
2276 * the @replaced_transfers - it may be spi_message.messages!
2277 */
2278 rxfer->replaced_after = xfer_first->transfer_list.prev;
2279
2280 /* remove the requested number of transfers */
2281 for (i = 0; i < remove; i++) {
2282 /* if the entry after replaced_after it is msg->transfers
2283 * then we have been requested to remove more transfers
2284 * than are in the list
2285 */
2286 if (rxfer->replaced_after->next == &msg->transfers) {
2287 dev_err(&msg->spi->dev,
2288 "requested to remove more spi_transfers than are available\n");
2289 /* insert replaced transfers back into the message */
2290 list_splice(&rxfer->replaced_transfers,
2291 rxfer->replaced_after);
2292
2293 /* free the spi_replace_transfer structure */
2294 spi_res_free(rxfer);
2295
2296 /* and return with an error */
2297 return ERR_PTR(-EINVAL);
2298 }
2299
2300 /* remove the entry after replaced_after from list of
2301 * transfers and add it to list of replaced_transfers
2302 */
2303 list_move_tail(rxfer->replaced_after->next,
2304 &rxfer->replaced_transfers);
2305 }
2306
2307 /* create copy of the given xfer with identical settings
2308 * based on the first transfer to get removed
2309 */
2310 for (i = 0; i < insert; i++) {
2311 /* we need to run in reverse order */
2312 xfer = &rxfer->inserted_transfers[insert - 1 - i];
2313
2314 /* copy all spi_transfer data */
2315 memcpy(xfer, xfer_first, sizeof(*xfer));
2316
2317 /* add to list */
2318 list_add(&xfer->transfer_list, rxfer->replaced_after);
2319
2320 /* clear cs_change and delay_usecs for all but the last */
2321 if (i) {
2322 xfer->cs_change = false;
2323 xfer->delay_usecs = 0;
2324 }
2325 }
2326
2327 /* set up inserted */
2328 rxfer->inserted = insert;
2329
2330 /* and register it with spi_res/spi_message */
2331 spi_res_add(msg, rxfer);
2332
2333 return rxfer;
2334}
2335EXPORT_SYMBOL_GPL(spi_replace_transfers);
2336
Fabio Estevam08933412016-02-14 13:33:50 -02002337static int __spi_split_transfer_maxsize(struct spi_master *master,
2338 struct spi_message *msg,
2339 struct spi_transfer **xferp,
2340 size_t maxsize,
2341 gfp_t gfp)
Martin Sperld9f12122015-12-14 15:20:20 +00002342{
2343 struct spi_transfer *xfer = *xferp, *xfers;
2344 struct spi_replaced_transfers *srt;
2345 size_t offset;
2346 size_t count, i;
2347
2348 /* warn once about this fact that we are splitting a transfer */
2349 dev_warn_once(&msg->spi->dev,
Fabio Estevam7d62f512016-02-17 15:42:27 -02002350 "spi_transfer of length %i exceed max length of %zu - needed to split transfers\n",
Martin Sperld9f12122015-12-14 15:20:20 +00002351 xfer->len, maxsize);
2352
2353 /* calculate how many we have to replace */
2354 count = DIV_ROUND_UP(xfer->len, maxsize);
2355
2356 /* create replacement */
2357 srt = spi_replace_transfers(msg, xfer, 1, count, NULL, 0, gfp);
Dan Carpenter657d32e2016-02-12 09:38:33 +03002358 if (IS_ERR(srt))
2359 return PTR_ERR(srt);
Martin Sperld9f12122015-12-14 15:20:20 +00002360 xfers = srt->inserted_transfers;
2361
2362 /* now handle each of those newly inserted spi_transfers
2363 * note that the replacements spi_transfers all are preset
2364 * to the same values as *xferp, so tx_buf, rx_buf and len
2365 * are all identical (as well as most others)
2366 * so we just have to fix up len and the pointers.
2367 *
2368 * this also includes support for the depreciated
2369 * spi_message.is_dma_mapped interface
2370 */
2371
2372 /* the first transfer just needs the length modified, so we
2373 * run it outside the loop
2374 */
Fabio Estevamc8dab772016-02-17 15:42:28 -02002375 xfers[0].len = min_t(size_t, maxsize, xfer[0].len);
Martin Sperld9f12122015-12-14 15:20:20 +00002376
2377 /* all the others need rx_buf/tx_buf also set */
2378 for (i = 1, offset = maxsize; i < count; offset += maxsize, i++) {
2379 /* update rx_buf, tx_buf and dma */
2380 if (xfers[i].rx_buf)
2381 xfers[i].rx_buf += offset;
2382 if (xfers[i].rx_dma)
2383 xfers[i].rx_dma += offset;
2384 if (xfers[i].tx_buf)
2385 xfers[i].tx_buf += offset;
2386 if (xfers[i].tx_dma)
2387 xfers[i].tx_dma += offset;
2388
2389 /* update length */
2390 xfers[i].len = min(maxsize, xfers[i].len - offset);
2391 }
2392
2393 /* we set up xferp to the last entry we have inserted,
2394 * so that we skip those already split transfers
2395 */
2396 *xferp = &xfers[count - 1];
2397
2398 /* increment statistics counters */
2399 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics,
2400 transfers_split_maxsize);
2401 SPI_STATISTICS_INCREMENT_FIELD(&msg->spi->statistics,
2402 transfers_split_maxsize);
2403
2404 return 0;
2405}
2406
2407/**
2408 * spi_split_tranfers_maxsize - split spi transfers into multiple transfers
2409 * when an individual transfer exceeds a
2410 * certain size
2411 * @master: the @spi_master for this transfer
Masanari Iida3700ce92016-02-22 20:33:44 +09002412 * @msg: the @spi_message to transform
2413 * @maxsize: the maximum when to apply this
Javier Martinez Canillas10f11a22016-03-10 15:01:14 -03002414 * @gfp: GFP allocation flags
Martin Sperld9f12122015-12-14 15:20:20 +00002415 *
2416 * Return: status of transformation
2417 */
2418int spi_split_transfers_maxsize(struct spi_master *master,
2419 struct spi_message *msg,
2420 size_t maxsize,
2421 gfp_t gfp)
2422{
2423 struct spi_transfer *xfer;
2424 int ret;
2425
2426 /* iterate over the transfer_list,
2427 * but note that xfer is advanced to the last transfer inserted
2428 * to avoid checking sizes again unnecessarily (also xfer does
2429 * potentiall belong to a different list by the time the
2430 * replacement has happened
2431 */
2432 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
2433 if (xfer->len > maxsize) {
2434 ret = __spi_split_transfer_maxsize(
2435 master, msg, &xfer, maxsize, gfp);
2436 if (ret)
2437 return ret;
2438 }
2439 }
2440
2441 return 0;
2442}
2443EXPORT_SYMBOL_GPL(spi_split_transfers_maxsize);
David Brownell8ae12a02006-01-08 13:34:19 -08002444
2445/*-------------------------------------------------------------------------*/
2446
David Brownell7d077192009-06-17 16:26:03 -07002447/* Core methods for SPI master protocol drivers. Some of the
2448 * other core methods are currently defined as inline functions.
2449 */
2450
Stefan Brüns63ab6452015-08-23 16:06:30 +02002451static int __spi_validate_bits_per_word(struct spi_master *master, u8 bits_per_word)
2452{
2453 if (master->bits_per_word_mask) {
2454 /* Only 32 bits fit in the mask */
2455 if (bits_per_word > 32)
2456 return -EINVAL;
2457 if (!(master->bits_per_word_mask &
2458 SPI_BPW_MASK(bits_per_word)))
2459 return -EINVAL;
2460 }
2461
2462 return 0;
2463}
2464
David Brownell7d077192009-06-17 16:26:03 -07002465/**
2466 * spi_setup - setup SPI mode and clock rate
2467 * @spi: the device whose settings are being modified
2468 * Context: can sleep, and no requests are queued to the device
2469 *
2470 * SPI protocol drivers may need to update the transfer mode if the
2471 * device doesn't work with its default. They may likewise need
2472 * to update clock rates or word sizes from initial values. This function
2473 * changes those settings, and must be called from a context that can sleep.
2474 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
2475 * effect the next time the device is selected and data is transferred to
2476 * or from it. When this function returns, the spi device is deselected.
2477 *
2478 * Note that this call will fail if the protocol driver specifies an option
2479 * that the underlying controller or its driver does not support. For
2480 * example, not all hardware supports wire transfers using nine bit words,
2481 * LSB-first wire encoding, or active-high chipselects.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002482 *
2483 * Return: zero on success, else a negative error code.
David Brownell7d077192009-06-17 16:26:03 -07002484 */
2485int spi_setup(struct spi_device *spi)
2486{
Geert Uytterhoeven83596fb2014-04-14 19:39:53 +02002487 unsigned bad_bits, ugly_bits;
Andy Shevchenko5ab8d262015-10-14 22:43:07 +03002488 int status;
David Brownell7d077192009-06-17 16:26:03 -07002489
wangyuhangf477b7f2013-08-11 18:15:17 +08002490 /* check mode to prevent that DUAL and QUAD set at the same time
2491 */
2492 if (((spi->mode & SPI_TX_DUAL) && (spi->mode & SPI_TX_QUAD)) ||
2493 ((spi->mode & SPI_RX_DUAL) && (spi->mode & SPI_RX_QUAD))) {
2494 dev_err(&spi->dev,
2495 "setup: can not select dual and quad at the same time\n");
2496 return -EINVAL;
2497 }
2498 /* if it is SPI_3WIRE mode, DUAL and QUAD should be forbidden
2499 */
2500 if ((spi->mode & SPI_3WIRE) && (spi->mode &
2501 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD)))
2502 return -EINVAL;
David Brownelle7db06b2009-06-17 16:26:04 -07002503 /* help drivers fail *cleanly* when they need options
2504 * that aren't supported with their current master
2505 */
2506 bad_bits = spi->mode & ~spi->master->mode_bits;
Geert Uytterhoeven83596fb2014-04-14 19:39:53 +02002507 ugly_bits = bad_bits &
2508 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD);
2509 if (ugly_bits) {
2510 dev_warn(&spi->dev,
2511 "setup: ignoring unsupported mode bits %x\n",
2512 ugly_bits);
2513 spi->mode &= ~ugly_bits;
2514 bad_bits &= ~ugly_bits;
2515 }
David Brownelle7db06b2009-06-17 16:26:04 -07002516 if (bad_bits) {
Linus Walleijeb288a12010-10-21 21:06:44 +02002517 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
David Brownelle7db06b2009-06-17 16:26:04 -07002518 bad_bits);
2519 return -EINVAL;
2520 }
2521
David Brownell7d077192009-06-17 16:26:03 -07002522 if (!spi->bits_per_word)
2523 spi->bits_per_word = 8;
2524
Andy Shevchenko5ab8d262015-10-14 22:43:07 +03002525 status = __spi_validate_bits_per_word(spi->master, spi->bits_per_word);
2526 if (status)
2527 return status;
Stefan Brüns63ab6452015-08-23 16:06:30 +02002528
Axel Lin052eb2d2014-02-10 00:08:05 +08002529 if (!spi->max_speed_hz)
2530 spi->max_speed_hz = spi->master->max_speed_hz;
2531
Laxman Dewangancaae0702012-11-09 14:35:22 +05302532 if (spi->master->setup)
2533 status = spi->master->setup(spi);
David Brownell7d077192009-06-17 16:26:03 -07002534
Franklin S Cooper Jrabeedb02015-10-16 10:29:03 -05002535 spi_set_cs(spi, false);
2536
Jingoo Han5fe5f052013-10-14 10:31:51 +09002537 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 -07002538 (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
2539 (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
2540 (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
2541 (spi->mode & SPI_3WIRE) ? "3wire, " : "",
2542 (spi->mode & SPI_LOOP) ? "loopback, " : "",
2543 spi->bits_per_word, spi->max_speed_hz,
2544 status);
2545
2546 return status;
2547}
2548EXPORT_SYMBOL_GPL(spi_setup);
2549
Mark Brown90808732013-11-13 23:44:15 +00002550static int __spi_validate(struct spi_device *spi, struct spi_message *message)
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002551{
2552 struct spi_master *master = spi->master;
Laxman Dewangane6811d12012-11-09 14:36:45 +05302553 struct spi_transfer *xfer;
Atsushi Nemoto6ea31292014-02-28 23:03:16 +09002554 int w_size;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002555
Mark Brown24a00132013-07-10 15:05:40 +01002556 if (list_empty(&message->transfers))
2557 return -EINVAL;
Mark Brown24a00132013-07-10 15:05:40 +01002558
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002559 /* Half-duplex links include original MicroWire, and ones with
2560 * only one data pin like SPI_3WIRE (switches direction) or where
2561 * either MOSI or MISO is missing. They can also be caused by
2562 * software limitations.
2563 */
2564 if ((master->flags & SPI_MASTER_HALF_DUPLEX)
2565 || (spi->mode & SPI_3WIRE)) {
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002566 unsigned flags = master->flags;
2567
2568 list_for_each_entry(xfer, &message->transfers, transfer_list) {
2569 if (xfer->rx_buf && xfer->tx_buf)
2570 return -EINVAL;
2571 if ((flags & SPI_MASTER_NO_TX) && xfer->tx_buf)
2572 return -EINVAL;
2573 if ((flags & SPI_MASTER_NO_RX) && xfer->rx_buf)
2574 return -EINVAL;
2575 }
2576 }
2577
Laxman Dewangane6811d12012-11-09 14:36:45 +05302578 /**
Laxman Dewangan059b8ff2013-01-05 00:17:14 +05302579 * Set transfer bits_per_word and max speed as spi device default if
2580 * it is not set for this transfer.
wangyuhangf477b7f2013-08-11 18:15:17 +08002581 * Set transfer tx_nbits and rx_nbits as single transfer default
2582 * (SPI_NBITS_SINGLE) if it is not set for this transfer.
Laxman Dewangane6811d12012-11-09 14:36:45 +05302583 */
Martin Sperl77e80582015-11-27 12:31:09 +00002584 message->frame_length = 0;
Laxman Dewangane6811d12012-11-09 14:36:45 +05302585 list_for_each_entry(xfer, &message->transfers, transfer_list) {
Sourav Poddar078726c2013-07-18 15:31:25 +05302586 message->frame_length += xfer->len;
Laxman Dewangane6811d12012-11-09 14:36:45 +05302587 if (!xfer->bits_per_word)
2588 xfer->bits_per_word = spi->bits_per_word;
Axel Lina6f87fa2014-03-17 10:08:12 +08002589
2590 if (!xfer->speed_hz)
Laxman Dewangan059b8ff2013-01-05 00:17:14 +05302591 xfer->speed_hz = spi->max_speed_hz;
Mark Brown7dc9fbc2015-08-20 11:52:18 -07002592 if (!xfer->speed_hz)
2593 xfer->speed_hz = master->max_speed_hz;
Axel Lina6f87fa2014-03-17 10:08:12 +08002594
2595 if (master->max_speed_hz &&
2596 xfer->speed_hz > master->max_speed_hz)
2597 xfer->speed_hz = master->max_speed_hz;
Gabor Juhos56ede942013-08-14 10:25:28 +02002598
Stefan Brüns63ab6452015-08-23 16:06:30 +02002599 if (__spi_validate_bits_per_word(master, xfer->bits_per_word))
2600 return -EINVAL;
Mark Browna2fd4f92013-07-10 14:57:26 +01002601
Ivan T. Ivanov4d94bd22014-02-20 12:02:08 +02002602 /*
2603 * SPI transfer length should be multiple of SPI word size
2604 * where SPI word size should be power-of-two multiple
2605 */
2606 if (xfer->bits_per_word <= 8)
2607 w_size = 1;
2608 else if (xfer->bits_per_word <= 16)
2609 w_size = 2;
2610 else
2611 w_size = 4;
2612
Ivan T. Ivanov4d94bd22014-02-20 12:02:08 +02002613 /* No partial transfers accepted */
Atsushi Nemoto6ea31292014-02-28 23:03:16 +09002614 if (xfer->len % w_size)
Ivan T. Ivanov4d94bd22014-02-20 12:02:08 +02002615 return -EINVAL;
2616
Mark Browna2fd4f92013-07-10 14:57:26 +01002617 if (xfer->speed_hz && master->min_speed_hz &&
2618 xfer->speed_hz < master->min_speed_hz)
2619 return -EINVAL;
wangyuhangf477b7f2013-08-11 18:15:17 +08002620
2621 if (xfer->tx_buf && !xfer->tx_nbits)
2622 xfer->tx_nbits = SPI_NBITS_SINGLE;
2623 if (xfer->rx_buf && !xfer->rx_nbits)
2624 xfer->rx_nbits = SPI_NBITS_SINGLE;
2625 /* check transfer tx/rx_nbits:
Geert Uytterhoeven1afd9982014-01-12 14:00:29 +01002626 * 1. check the value matches one of single, dual and quad
2627 * 2. check tx/rx_nbits match the mode in spi_device
wangyuhangf477b7f2013-08-11 18:15:17 +08002628 */
Sourav Poddardb90a442013-08-22 21:20:48 +05302629 if (xfer->tx_buf) {
2630 if (xfer->tx_nbits != SPI_NBITS_SINGLE &&
2631 xfer->tx_nbits != SPI_NBITS_DUAL &&
2632 xfer->tx_nbits != SPI_NBITS_QUAD)
2633 return -EINVAL;
2634 if ((xfer->tx_nbits == SPI_NBITS_DUAL) &&
2635 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
2636 return -EINVAL;
2637 if ((xfer->tx_nbits == SPI_NBITS_QUAD) &&
2638 !(spi->mode & SPI_TX_QUAD))
2639 return -EINVAL;
Sourav Poddardb90a442013-08-22 21:20:48 +05302640 }
wangyuhangf477b7f2013-08-11 18:15:17 +08002641 /* check transfer rx_nbits */
Sourav Poddardb90a442013-08-22 21:20:48 +05302642 if (xfer->rx_buf) {
2643 if (xfer->rx_nbits != SPI_NBITS_SINGLE &&
2644 xfer->rx_nbits != SPI_NBITS_DUAL &&
2645 xfer->rx_nbits != SPI_NBITS_QUAD)
2646 return -EINVAL;
2647 if ((xfer->rx_nbits == SPI_NBITS_DUAL) &&
2648 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
2649 return -EINVAL;
2650 if ((xfer->rx_nbits == SPI_NBITS_QUAD) &&
2651 !(spi->mode & SPI_RX_QUAD))
2652 return -EINVAL;
Sourav Poddardb90a442013-08-22 21:20:48 +05302653 }
Laxman Dewangane6811d12012-11-09 14:36:45 +05302654 }
2655
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002656 message->status = -EINPROGRESS;
Mark Brown90808732013-11-13 23:44:15 +00002657
2658 return 0;
2659}
2660
2661static int __spi_async(struct spi_device *spi, struct spi_message *message)
2662{
2663 struct spi_master *master = spi->master;
2664
2665 message->spi = spi;
2666
Martin Sperleca2ebc2015-06-22 13:00:36 +00002667 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics, spi_async);
2668 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_async);
2669
Mark Brown90808732013-11-13 23:44:15 +00002670 trace_spi_message_submit(message);
2671
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002672 return master->transfer(spi, message);
2673}
2674
David Brownell568d0692009-09-22 16:46:18 -07002675/**
2676 * spi_async - asynchronous SPI transfer
2677 * @spi: device with which data will be exchanged
2678 * @message: describes the data transfers, including completion callback
2679 * Context: any (irqs may be blocked, etc)
2680 *
2681 * This call may be used in_irq and other contexts which can't sleep,
2682 * as well as from task contexts which can sleep.
2683 *
2684 * The completion callback is invoked in a context which can't sleep.
2685 * Before that invocation, the value of message->status is undefined.
2686 * When the callback is issued, message->status holds either zero (to
2687 * indicate complete success) or a negative error code. After that
2688 * callback returns, the driver which issued the transfer request may
2689 * deallocate the associated memory; it's no longer in use by any SPI
2690 * core or controller driver code.
2691 *
2692 * Note that although all messages to a spi_device are handled in
2693 * FIFO order, messages may go to different devices in other orders.
2694 * Some device might be higher priority, or have various "hard" access
2695 * time requirements, for example.
2696 *
2697 * On detection of any fault during the transfer, processing of
2698 * the entire message is aborted, and the device is deselected.
2699 * Until returning from the associated message completion callback,
2700 * no other spi_message queued to that device will be processed.
2701 * (This rule applies equally to all the synchronous transfer calls,
2702 * which are wrappers around this core asynchronous primitive.)
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002703 *
2704 * Return: zero on success, else a negative error code.
David Brownell568d0692009-09-22 16:46:18 -07002705 */
2706int spi_async(struct spi_device *spi, struct spi_message *message)
2707{
2708 struct spi_master *master = spi->master;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002709 int ret;
2710 unsigned long flags;
David Brownell568d0692009-09-22 16:46:18 -07002711
Mark Brown90808732013-11-13 23:44:15 +00002712 ret = __spi_validate(spi, message);
2713 if (ret != 0)
2714 return ret;
2715
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002716 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
David Brownell568d0692009-09-22 16:46:18 -07002717
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002718 if (master->bus_lock_flag)
2719 ret = -EBUSY;
2720 else
2721 ret = __spi_async(spi, message);
David Brownell568d0692009-09-22 16:46:18 -07002722
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002723 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2724
2725 return ret;
David Brownell568d0692009-09-22 16:46:18 -07002726}
2727EXPORT_SYMBOL_GPL(spi_async);
2728
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002729/**
2730 * spi_async_locked - version of spi_async with exclusive bus usage
2731 * @spi: device with which data will be exchanged
2732 * @message: describes the data transfers, including completion callback
2733 * Context: any (irqs may be blocked, etc)
2734 *
2735 * This call may be used in_irq and other contexts which can't sleep,
2736 * as well as from task contexts which can sleep.
2737 *
2738 * The completion callback is invoked in a context which can't sleep.
2739 * Before that invocation, the value of message->status is undefined.
2740 * When the callback is issued, message->status holds either zero (to
2741 * indicate complete success) or a negative error code. After that
2742 * callback returns, the driver which issued the transfer request may
2743 * deallocate the associated memory; it's no longer in use by any SPI
2744 * core or controller driver code.
2745 *
2746 * Note that although all messages to a spi_device are handled in
2747 * FIFO order, messages may go to different devices in other orders.
2748 * Some device might be higher priority, or have various "hard" access
2749 * time requirements, for example.
2750 *
2751 * On detection of any fault during the transfer, processing of
2752 * the entire message is aborted, and the device is deselected.
2753 * Until returning from the associated message completion callback,
2754 * no other spi_message queued to that device will be processed.
2755 * (This rule applies equally to all the synchronous transfer calls,
2756 * which are wrappers around this core asynchronous primitive.)
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002757 *
2758 * Return: zero on success, else a negative error code.
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002759 */
2760int spi_async_locked(struct spi_device *spi, struct spi_message *message)
2761{
2762 struct spi_master *master = spi->master;
2763 int ret;
2764 unsigned long flags;
2765
Mark Brown90808732013-11-13 23:44:15 +00002766 ret = __spi_validate(spi, message);
2767 if (ret != 0)
2768 return ret;
2769
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002770 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2771
2772 ret = __spi_async(spi, message);
2773
2774 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2775
2776 return ret;
2777
2778}
2779EXPORT_SYMBOL_GPL(spi_async_locked);
2780
David Brownell7d077192009-06-17 16:26:03 -07002781
Vignesh R556351f2015-12-11 09:39:56 +05302782int spi_flash_read(struct spi_device *spi,
2783 struct spi_flash_read_message *msg)
2784
2785{
2786 struct spi_master *master = spi->master;
Vignesh Rf4502dd2016-06-08 12:18:31 +05302787 struct device *rx_dev = NULL;
Vignesh R556351f2015-12-11 09:39:56 +05302788 int ret;
2789
2790 if ((msg->opcode_nbits == SPI_NBITS_DUAL ||
2791 msg->addr_nbits == SPI_NBITS_DUAL) &&
2792 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
2793 return -EINVAL;
2794 if ((msg->opcode_nbits == SPI_NBITS_QUAD ||
2795 msg->addr_nbits == SPI_NBITS_QUAD) &&
2796 !(spi->mode & SPI_TX_QUAD))
2797 return -EINVAL;
2798 if (msg->data_nbits == SPI_NBITS_DUAL &&
2799 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
2800 return -EINVAL;
2801 if (msg->data_nbits == SPI_NBITS_QUAD &&
2802 !(spi->mode & SPI_RX_QUAD))
2803 return -EINVAL;
2804
2805 if (master->auto_runtime_pm) {
2806 ret = pm_runtime_get_sync(master->dev.parent);
2807 if (ret < 0) {
2808 dev_err(&master->dev, "Failed to power device: %d\n",
2809 ret);
2810 return ret;
2811 }
2812 }
Vignesh Rf4502dd2016-06-08 12:18:31 +05302813
Vignesh R556351f2015-12-11 09:39:56 +05302814 mutex_lock(&master->bus_lock_mutex);
Mark Brownef4d96e2016-07-21 23:53:31 +01002815 mutex_lock(&master->io_mutex);
Vignesh Rf4502dd2016-06-08 12:18:31 +05302816 if (master->dma_rx) {
2817 rx_dev = master->dma_rx->device->dev;
2818 ret = spi_map_buf(master, rx_dev, &msg->rx_sg,
2819 msg->buf, msg->len,
2820 DMA_FROM_DEVICE);
2821 if (!ret)
2822 msg->cur_msg_mapped = true;
2823 }
Vignesh R556351f2015-12-11 09:39:56 +05302824 ret = master->spi_flash_read(spi, msg);
Vignesh Rf4502dd2016-06-08 12:18:31 +05302825 if (msg->cur_msg_mapped)
2826 spi_unmap_buf(master, rx_dev, &msg->rx_sg,
2827 DMA_FROM_DEVICE);
Mark Brownef4d96e2016-07-21 23:53:31 +01002828 mutex_unlock(&master->io_mutex);
Vignesh R556351f2015-12-11 09:39:56 +05302829 mutex_unlock(&master->bus_lock_mutex);
Vignesh Rf4502dd2016-06-08 12:18:31 +05302830
Vignesh R556351f2015-12-11 09:39:56 +05302831 if (master->auto_runtime_pm)
2832 pm_runtime_put(master->dev.parent);
2833
2834 return ret;
2835}
2836EXPORT_SYMBOL_GPL(spi_flash_read);
2837
David Brownell7d077192009-06-17 16:26:03 -07002838/*-------------------------------------------------------------------------*/
2839
2840/* Utility methods for SPI master protocol drivers, layered on
2841 * top of the core. Some other utility methods are defined as
2842 * inline functions.
2843 */
2844
Andrew Morton5d870c82006-01-11 11:23:49 -08002845static void spi_complete(void *arg)
2846{
2847 complete(arg);
2848}
2849
Mark Brownef4d96e2016-07-21 23:53:31 +01002850static int __spi_sync(struct spi_device *spi, struct spi_message *message)
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002851{
2852 DECLARE_COMPLETION_ONSTACK(done);
2853 int status;
2854 struct spi_master *master = spi->master;
Mark Brown0461a412014-12-09 21:38:05 +00002855 unsigned long flags;
2856
2857 status = __spi_validate(spi, message);
2858 if (status != 0)
2859 return status;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002860
2861 message->complete = spi_complete;
2862 message->context = &done;
Mark Brown0461a412014-12-09 21:38:05 +00002863 message->spi = spi;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002864
Martin Sperleca2ebc2015-06-22 13:00:36 +00002865 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics, spi_sync);
2866 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_sync);
2867
Mark Brown0461a412014-12-09 21:38:05 +00002868 /* If we're not using the legacy transfer method then we will
2869 * try to transfer in the calling context so special case.
2870 * This code would be less tricky if we could remove the
2871 * support for driver implemented message queues.
2872 */
2873 if (master->transfer == spi_queued_transfer) {
2874 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2875
2876 trace_spi_message_submit(message);
2877
2878 status = __spi_queued_transfer(spi, message, false);
2879
2880 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2881 } else {
2882 status = spi_async_locked(spi, message);
2883 }
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002884
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002885 if (status == 0) {
Mark Brown0461a412014-12-09 21:38:05 +00002886 /* Push out the messages in the calling context if we
2887 * can.
2888 */
Martin Sperleca2ebc2015-06-22 13:00:36 +00002889 if (master->transfer == spi_queued_transfer) {
2890 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics,
2891 spi_sync_immediate);
2892 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics,
2893 spi_sync_immediate);
Mark Brownef4d96e2016-07-21 23:53:31 +01002894 __spi_pump_messages(master, false);
Martin Sperleca2ebc2015-06-22 13:00:36 +00002895 }
Mark Brown0461a412014-12-09 21:38:05 +00002896
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002897 wait_for_completion(&done);
2898 status = message->status;
2899 }
2900 message->context = NULL;
2901 return status;
2902}
2903
David Brownell8ae12a02006-01-08 13:34:19 -08002904/**
2905 * spi_sync - blocking/synchronous SPI data transfers
2906 * @spi: device with which data will be exchanged
2907 * @message: describes the data transfers
David Brownell33e34dc2007-05-08 00:32:21 -07002908 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08002909 *
2910 * This call may only be used from a context that may sleep. The sleep
2911 * is non-interruptible, and has no timeout. Low-overhead controller
2912 * drivers may DMA directly into and out of the message buffers.
2913 *
2914 * Note that the SPI device's chip select is active during the message,
2915 * and then is normally disabled between messages. Drivers for some
2916 * frequently-used devices may want to minimize costs of selecting a chip,
2917 * by leaving it selected in anticipation that the next message will go
2918 * to the same chip. (That may increase power usage.)
2919 *
David Brownell0c8684612006-01-08 13:34:25 -08002920 * Also, the caller is guaranteeing that the memory associated with the
2921 * message will not be freed before this call returns.
2922 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002923 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08002924 */
2925int spi_sync(struct spi_device *spi, struct spi_message *message)
2926{
Mark Brownef4d96e2016-07-21 23:53:31 +01002927 int ret;
2928
2929 mutex_lock(&spi->master->bus_lock_mutex);
2930 ret = __spi_sync(spi, message);
2931 mutex_unlock(&spi->master->bus_lock_mutex);
2932
2933 return ret;
David Brownell8ae12a02006-01-08 13:34:19 -08002934}
2935EXPORT_SYMBOL_GPL(spi_sync);
2936
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002937/**
2938 * spi_sync_locked - version of spi_sync with exclusive bus usage
2939 * @spi: device with which data will be exchanged
2940 * @message: describes the data transfers
2941 * Context: can sleep
2942 *
2943 * This call may only be used from a context that may sleep. The sleep
2944 * is non-interruptible, and has no timeout. Low-overhead controller
2945 * drivers may DMA directly into and out of the message buffers.
2946 *
2947 * This call should be used by drivers that require exclusive access to the
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002948 * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002949 * be released by a spi_bus_unlock call when the exclusive access is over.
2950 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002951 * Return: zero on success, else a negative error code.
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002952 */
2953int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
2954{
Mark Brownef4d96e2016-07-21 23:53:31 +01002955 return __spi_sync(spi, message);
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002956}
2957EXPORT_SYMBOL_GPL(spi_sync_locked);
2958
2959/**
2960 * spi_bus_lock - obtain a lock for exclusive SPI bus usage
2961 * @master: SPI bus master that should be locked for exclusive bus access
2962 * Context: can sleep
2963 *
2964 * This call may only be used from a context that may sleep. The sleep
2965 * is non-interruptible, and has no timeout.
2966 *
2967 * This call should be used by drivers that require exclusive access to the
2968 * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
2969 * exclusive access is over. Data transfer must be done by spi_sync_locked
2970 * and spi_async_locked calls when the SPI bus lock is held.
2971 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002972 * Return: always zero.
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002973 */
2974int spi_bus_lock(struct spi_master *master)
2975{
2976 unsigned long flags;
2977
2978 mutex_lock(&master->bus_lock_mutex);
2979
2980 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2981 master->bus_lock_flag = 1;
2982 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2983
2984 /* mutex remains locked until spi_bus_unlock is called */
2985
2986 return 0;
2987}
2988EXPORT_SYMBOL_GPL(spi_bus_lock);
2989
2990/**
2991 * spi_bus_unlock - release the lock for exclusive SPI bus usage
2992 * @master: SPI bus master that was locked for exclusive bus access
2993 * Context: can sleep
2994 *
2995 * This call may only be used from a context that may sleep. The sleep
2996 * is non-interruptible, and has no timeout.
2997 *
2998 * This call releases an SPI bus lock previously obtained by an spi_bus_lock
2999 * call.
3000 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02003001 * Return: always zero.
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07003002 */
3003int spi_bus_unlock(struct spi_master *master)
3004{
3005 master->bus_lock_flag = 0;
3006
3007 mutex_unlock(&master->bus_lock_mutex);
3008
3009 return 0;
3010}
3011EXPORT_SYMBOL_GPL(spi_bus_unlock);
3012
David Brownella9948b62006-04-02 10:37:40 -08003013/* portable code must never pass more than 32 bytes */
Jingoo Han5fe5f052013-10-14 10:31:51 +09003014#define SPI_BUFSIZ max(32, SMP_CACHE_BYTES)
David Brownell8ae12a02006-01-08 13:34:19 -08003015
3016static u8 *buf;
3017
3018/**
3019 * spi_write_then_read - SPI synchronous write followed by read
3020 * @spi: device with which data will be exchanged
3021 * @txbuf: data to be written (need not be dma-safe)
3022 * @n_tx: size of txbuf, in bytes
Jiri Pirko27570492009-06-17 16:26:06 -07003023 * @rxbuf: buffer into which data will be read (need not be dma-safe)
3024 * @n_rx: size of rxbuf, in bytes
David Brownell33e34dc2007-05-08 00:32:21 -07003025 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08003026 *
3027 * This performs a half duplex MicroWire style transaction with the
3028 * device, sending txbuf and then reading rxbuf. The return value
3029 * is zero for success, else a negative errno status code.
David Brownellb8852442006-01-08 13:34:23 -08003030 * This call may only be used from a context that may sleep.
David Brownell8ae12a02006-01-08 13:34:19 -08003031 *
David Brownell0c8684612006-01-08 13:34:25 -08003032 * Parameters to this routine are always copied using a small buffer;
David Brownell33e34dc2007-05-08 00:32:21 -07003033 * portable code should never use this for more than 32 bytes.
3034 * Performance-sensitive or bulk transfer code should instead use
David Brownell0c8684612006-01-08 13:34:25 -08003035 * spi_{async,sync}() calls with dma-safe buffers.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02003036 *
3037 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08003038 */
3039int spi_write_then_read(struct spi_device *spi,
Mark Brown0c4a1592011-05-11 00:09:30 +02003040 const void *txbuf, unsigned n_tx,
3041 void *rxbuf, unsigned n_rx)
David Brownell8ae12a02006-01-08 13:34:19 -08003042{
David Brownell068f4072007-12-04 23:45:09 -08003043 static DEFINE_MUTEX(lock);
David Brownell8ae12a02006-01-08 13:34:19 -08003044
3045 int status;
3046 struct spi_message message;
David Brownellbdff5492009-04-13 14:39:57 -07003047 struct spi_transfer x[2];
David Brownell8ae12a02006-01-08 13:34:19 -08003048 u8 *local_buf;
3049
Mark Brownb3a223e2012-12-02 12:54:25 +09003050 /* Use preallocated DMA-safe buffer if we can. We can't avoid
3051 * copying here, (as a pure convenience thing), but we can
3052 * keep heap costs out of the hot path unless someone else is
3053 * using the pre-allocated buffer or the transfer is too large.
David Brownell8ae12a02006-01-08 13:34:19 -08003054 */
Mark Brownb3a223e2012-12-02 12:54:25 +09003055 if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
Mark Brown2cd94c82013-01-27 14:35:04 +08003056 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
3057 GFP_KERNEL | GFP_DMA);
Mark Brownb3a223e2012-12-02 12:54:25 +09003058 if (!local_buf)
3059 return -ENOMEM;
3060 } else {
3061 local_buf = buf;
3062 }
David Brownell8ae12a02006-01-08 13:34:19 -08003063
Vitaly Wool8275c642006-01-08 13:34:28 -08003064 spi_message_init(&message);
Jingoo Han5fe5f052013-10-14 10:31:51 +09003065 memset(x, 0, sizeof(x));
David Brownellbdff5492009-04-13 14:39:57 -07003066 if (n_tx) {
3067 x[0].len = n_tx;
3068 spi_message_add_tail(&x[0], &message);
3069 }
3070 if (n_rx) {
3071 x[1].len = n_rx;
3072 spi_message_add_tail(&x[1], &message);
3073 }
Vitaly Wool8275c642006-01-08 13:34:28 -08003074
David Brownell8ae12a02006-01-08 13:34:19 -08003075 memcpy(local_buf, txbuf, n_tx);
David Brownellbdff5492009-04-13 14:39:57 -07003076 x[0].tx_buf = local_buf;
3077 x[1].rx_buf = local_buf + n_tx;
David Brownell8ae12a02006-01-08 13:34:19 -08003078
3079 /* do the i/o */
David Brownell8ae12a02006-01-08 13:34:19 -08003080 status = spi_sync(spi, &message);
Marc Pignat9b938b72007-12-04 23:45:10 -08003081 if (status == 0)
David Brownellbdff5492009-04-13 14:39:57 -07003082 memcpy(rxbuf, x[1].rx_buf, n_rx);
David Brownell8ae12a02006-01-08 13:34:19 -08003083
David Brownellbdff5492009-04-13 14:39:57 -07003084 if (x[0].tx_buf == buf)
David Brownell068f4072007-12-04 23:45:09 -08003085 mutex_unlock(&lock);
David Brownell8ae12a02006-01-08 13:34:19 -08003086 else
3087 kfree(local_buf);
3088
3089 return status;
3090}
3091EXPORT_SYMBOL_GPL(spi_write_then_read);
3092
3093/*-------------------------------------------------------------------------*/
3094
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003095#if IS_ENABLED(CONFIG_OF_DYNAMIC)
3096static int __spi_of_device_match(struct device *dev, void *data)
3097{
3098 return dev->of_node == data;
3099}
3100
3101/* must call put_device() when done with returned spi_device device */
3102static struct spi_device *of_find_spi_device_by_node(struct device_node *node)
3103{
3104 struct device *dev = bus_find_device(&spi_bus_type, NULL, node,
3105 __spi_of_device_match);
3106 return dev ? to_spi_device(dev) : NULL;
3107}
3108
3109static int __spi_of_master_match(struct device *dev, const void *data)
3110{
3111 return dev->of_node == data;
3112}
3113
3114/* the spi masters are not using spi_bus, so we find it with another way */
3115static struct spi_master *of_find_spi_master_by_node(struct device_node *node)
3116{
3117 struct device *dev;
3118
3119 dev = class_find_device(&spi_master_class, NULL, node,
3120 __spi_of_master_match);
3121 if (!dev)
3122 return NULL;
3123
3124 /* reference got in class_find_device */
3125 return container_of(dev, struct spi_master, dev);
3126}
3127
3128static int of_spi_notify(struct notifier_block *nb, unsigned long action,
3129 void *arg)
3130{
3131 struct of_reconfig_data *rd = arg;
3132 struct spi_master *master;
3133 struct spi_device *spi;
3134
3135 switch (of_reconfig_get_state_change(action, arg)) {
3136 case OF_RECONFIG_CHANGE_ADD:
3137 master = of_find_spi_master_by_node(rd->dn->parent);
3138 if (master == NULL)
3139 return NOTIFY_OK; /* not for us */
3140
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +01003141 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED)) {
3142 put_device(&master->dev);
3143 return NOTIFY_OK;
3144 }
3145
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003146 spi = of_register_spi_device(master, rd->dn);
3147 put_device(&master->dev);
3148
3149 if (IS_ERR(spi)) {
3150 pr_err("%s: failed to create for '%s'\n",
3151 __func__, rd->dn->full_name);
Ralf Ramsauere0af98a2016-10-17 15:59:56 +02003152 of_node_clear_flag(rd->dn, OF_POPULATED);
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003153 return notifier_from_errno(PTR_ERR(spi));
3154 }
3155 break;
3156
3157 case OF_RECONFIG_CHANGE_REMOVE:
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +01003158 /* already depopulated? */
3159 if (!of_node_check_flag(rd->dn, OF_POPULATED))
3160 return NOTIFY_OK;
3161
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003162 /* find our device by node */
3163 spi = of_find_spi_device_by_node(rd->dn);
3164 if (spi == NULL)
3165 return NOTIFY_OK; /* no? not meant for us */
3166
3167 /* unregister takes one ref away */
3168 spi_unregister_device(spi);
3169
3170 /* and put the reference of the find */
3171 put_device(&spi->dev);
3172 break;
3173 }
3174
3175 return NOTIFY_OK;
3176}
3177
3178static struct notifier_block spi_of_notifier = {
3179 .notifier_call = of_spi_notify,
3180};
3181#else /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
3182extern struct notifier_block spi_of_notifier;
3183#endif /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
3184
Octavian Purdila7f244672016-07-08 19:13:11 +03003185#if IS_ENABLED(CONFIG_ACPI)
3186static int spi_acpi_master_match(struct device *dev, const void *data)
3187{
3188 return ACPI_COMPANION(dev->parent) == data;
3189}
3190
3191static int spi_acpi_device_match(struct device *dev, void *data)
3192{
3193 return ACPI_COMPANION(dev) == data;
3194}
3195
3196static struct spi_master *acpi_spi_find_master_by_adev(struct acpi_device *adev)
3197{
3198 struct device *dev;
3199
3200 dev = class_find_device(&spi_master_class, NULL, adev,
3201 spi_acpi_master_match);
3202 if (!dev)
3203 return NULL;
3204
3205 return container_of(dev, struct spi_master, dev);
3206}
3207
3208static struct spi_device *acpi_spi_find_device_by_adev(struct acpi_device *adev)
3209{
3210 struct device *dev;
3211
3212 dev = bus_find_device(&spi_bus_type, NULL, adev, spi_acpi_device_match);
3213
3214 return dev ? to_spi_device(dev) : NULL;
3215}
3216
3217static int acpi_spi_notify(struct notifier_block *nb, unsigned long value,
3218 void *arg)
3219{
3220 struct acpi_device *adev = arg;
3221 struct spi_master *master;
3222 struct spi_device *spi;
3223
3224 switch (value) {
3225 case ACPI_RECONFIG_DEVICE_ADD:
3226 master = acpi_spi_find_master_by_adev(adev->parent);
3227 if (!master)
3228 break;
3229
3230 acpi_register_spi_device(master, adev);
3231 put_device(&master->dev);
3232 break;
3233 case ACPI_RECONFIG_DEVICE_REMOVE:
3234 if (!acpi_device_enumerated(adev))
3235 break;
3236
3237 spi = acpi_spi_find_device_by_adev(adev);
3238 if (!spi)
3239 break;
3240
3241 spi_unregister_device(spi);
3242 put_device(&spi->dev);
3243 break;
3244 }
3245
3246 return NOTIFY_OK;
3247}
3248
3249static struct notifier_block spi_acpi_notifier = {
3250 .notifier_call = acpi_spi_notify,
3251};
3252#else
3253extern struct notifier_block spi_acpi_notifier;
3254#endif
3255
David Brownell8ae12a02006-01-08 13:34:19 -08003256static int __init spi_init(void)
3257{
David Brownellb8852442006-01-08 13:34:23 -08003258 int status;
David Brownell8ae12a02006-01-08 13:34:19 -08003259
Christoph Lametere94b1762006-12-06 20:33:17 -08003260 buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
David Brownellb8852442006-01-08 13:34:23 -08003261 if (!buf) {
3262 status = -ENOMEM;
3263 goto err0;
3264 }
3265
3266 status = bus_register(&spi_bus_type);
3267 if (status < 0)
3268 goto err1;
3269
3270 status = class_register(&spi_master_class);
3271 if (status < 0)
3272 goto err2;
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003273
Fabio Estevam52677202014-11-26 20:13:57 -02003274 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003275 WARN_ON(of_reconfig_notifier_register(&spi_of_notifier));
Octavian Purdila7f244672016-07-08 19:13:11 +03003276 if (IS_ENABLED(CONFIG_ACPI))
3277 WARN_ON(acpi_reconfig_notifier_register(&spi_acpi_notifier));
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003278
David Brownell8ae12a02006-01-08 13:34:19 -08003279 return 0;
David Brownellb8852442006-01-08 13:34:23 -08003280
3281err2:
3282 bus_unregister(&spi_bus_type);
3283err1:
3284 kfree(buf);
3285 buf = NULL;
3286err0:
3287 return status;
David Brownell8ae12a02006-01-08 13:34:19 -08003288}
David Brownellb8852442006-01-08 13:34:23 -08003289
David Brownell8ae12a02006-01-08 13:34:19 -08003290/* board_info is normally registered in arch_initcall(),
3291 * but even essential drivers wait till later
David Brownellb8852442006-01-08 13:34:23 -08003292 *
3293 * REVISIT only boardinfo really needs static linking. the rest (device and
3294 * driver registration) _could_ be dynamically linked (modular) ... costs
3295 * include needing to have boardinfo data structures be much more public.
David Brownell8ae12a02006-01-08 13:34:19 -08003296 */
David Brownell673c0c02008-10-15 22:02:46 -07003297postcore_initcall(spi_init);
David Brownell8ae12a02006-01-08 13:34:19 -08003298