blob: 2cfe67f734760948a282e19ab5cc41733ae466ed [file] [log] [blame]
David Brownell8ae12a02006-01-08 13:34:19 -08001/*
Grant Likelyca632f52011-06-06 01:16:30 -06002 * SPI init/core code
David Brownell8ae12a02006-01-08 13:34:19 -08003 *
4 * Copyright (C) 2005 David Brownell
Grant Likelyd57a4282012-04-07 14:16:53 -06005 * Copyright (C) 2008 Secret Lab Technologies Ltd.
David Brownell8ae12a02006-01-08 13:34:19 -08006 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
David Brownell8ae12a02006-01-08 13:34:19 -080016 */
17
David Brownell8ae12a02006-01-08 13:34:19 -080018#include <linux/kernel.h>
19#include <linux/device.h>
20#include <linux/init.h>
21#include <linux/cache.h>
Mark Brown99adef32014-01-16 12:22:43 +000022#include <linux/dma-mapping.h>
23#include <linux/dmaengine.h>
Matthias Kaehlcke94040822007-07-17 04:04:16 -070024#include <linux/mutex.h>
Sinan Akman2b7a32f2010-10-02 21:28:29 -060025#include <linux/of_device.h>
Grant Likelyd57a4282012-04-07 14:16:53 -060026#include <linux/of_irq.h>
Sylwester Nawrocki86be4082014-06-18 17:29:32 +020027#include <linux/clk/clk-conf.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090028#include <linux/slab.h>
Anton Vorontsove0626e32009-09-22 16:46:08 -070029#include <linux/mod_devicetable.h>
David Brownell8ae12a02006-01-08 13:34:19 -080030#include <linux/spi/spi.h>
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +010031#include <linux/of_gpio.h>
Mark Brown3ae22e82010-12-25 15:32:27 +010032#include <linux/pm_runtime.h>
Ulf Hanssonf48c7672014-09-29 13:58:47 +020033#include <linux/pm_domain.h>
Paul Gortmaker025ed132011-07-10 12:57:55 -040034#include <linux/export.h>
Clark Williams8bd75c72013-02-07 09:47:07 -060035#include <linux/sched/rt.h>
Linus Walleijffbbdd212012-02-22 10:05:38 +010036#include <linux/delay.h>
37#include <linux/kthread.h>
Mika Westerberg64bee4d2012-11-30 12:37:53 +010038#include <linux/ioport.h>
39#include <linux/acpi.h>
Vignesh Rb1b81532016-08-17 15:22:36 +053040#include <linux/highmem.h>
David Brownell8ae12a02006-01-08 13:34:19 -080041
Mark Brown56ec1972013-10-07 19:33:53 +010042#define CREATE_TRACE_POINTS
43#include <trace/events/spi.h>
44
David Brownell8ae12a02006-01-08 13:34:19 -080045static void spidev_release(struct device *dev)
46{
Hans-Peter Nilsson0ffa0282007-02-12 00:52:45 -080047 struct spi_device *spi = to_spi_device(dev);
David Brownell8ae12a02006-01-08 13:34:19 -080048
49 /* spi masters may cleanup for released devices */
50 if (spi->master->cleanup)
51 spi->master->cleanup(spi);
52
David Brownell0c868462006-01-08 13:34:25 -080053 spi_master_put(spi->master);
Roman Tereshonkov07a389f2010-04-12 09:56:35 +000054 kfree(spi);
David Brownell8ae12a02006-01-08 13:34:19 -080055}
56
57static ssize_t
58modalias_show(struct device *dev, struct device_attribute *a, char *buf)
59{
60 const struct spi_device *spi = to_spi_device(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +080061 int len;
62
63 len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
64 if (len != -ENODEV)
65 return len;
David Brownell8ae12a02006-01-08 13:34:19 -080066
Grant Likelyd8e328b2012-05-20 00:08:13 -060067 return sprintf(buf, "%s%s\n", SPI_MODULE_PREFIX, spi->modalias);
David Brownell8ae12a02006-01-08 13:34:19 -080068}
Greg Kroah-Hartmanaa7da562013-10-07 18:27:38 -070069static DEVICE_ATTR_RO(modalias);
David Brownell8ae12a02006-01-08 13:34:19 -080070
Martin Sperleca2ebc2015-06-22 13:00:36 +000071#define SPI_STATISTICS_ATTRS(field, file) \
72static ssize_t spi_master_##field##_show(struct device *dev, \
73 struct device_attribute *attr, \
74 char *buf) \
75{ \
76 struct spi_master *master = container_of(dev, \
77 struct spi_master, dev); \
78 return spi_statistics_##field##_show(&master->statistics, buf); \
79} \
80static struct device_attribute dev_attr_spi_master_##field = { \
81 .attr = { .name = file, .mode = S_IRUGO }, \
82 .show = spi_master_##field##_show, \
83}; \
84static ssize_t spi_device_##field##_show(struct device *dev, \
85 struct device_attribute *attr, \
86 char *buf) \
87{ \
Geliang Tangd1eba932015-12-23 00:18:41 +080088 struct spi_device *spi = to_spi_device(dev); \
Martin Sperleca2ebc2015-06-22 13:00:36 +000089 return spi_statistics_##field##_show(&spi->statistics, buf); \
90} \
91static struct device_attribute dev_attr_spi_device_##field = { \
92 .attr = { .name = file, .mode = S_IRUGO }, \
93 .show = spi_device_##field##_show, \
94}
95
96#define SPI_STATISTICS_SHOW_NAME(name, file, field, format_string) \
97static ssize_t spi_statistics_##name##_show(struct spi_statistics *stat, \
98 char *buf) \
99{ \
100 unsigned long flags; \
101 ssize_t len; \
102 spin_lock_irqsave(&stat->lock, flags); \
103 len = sprintf(buf, format_string, stat->field); \
104 spin_unlock_irqrestore(&stat->lock, flags); \
105 return len; \
106} \
107SPI_STATISTICS_ATTRS(name, file)
108
109#define SPI_STATISTICS_SHOW(field, format_string) \
110 SPI_STATISTICS_SHOW_NAME(field, __stringify(field), \
111 field, format_string)
112
113SPI_STATISTICS_SHOW(messages, "%lu");
114SPI_STATISTICS_SHOW(transfers, "%lu");
115SPI_STATISTICS_SHOW(errors, "%lu");
116SPI_STATISTICS_SHOW(timedout, "%lu");
117
118SPI_STATISTICS_SHOW(spi_sync, "%lu");
119SPI_STATISTICS_SHOW(spi_sync_immediate, "%lu");
120SPI_STATISTICS_SHOW(spi_async, "%lu");
121
122SPI_STATISTICS_SHOW(bytes, "%llu");
123SPI_STATISTICS_SHOW(bytes_rx, "%llu");
124SPI_STATISTICS_SHOW(bytes_tx, "%llu");
125
Martin Sperl6b7bc062015-06-22 13:02:04 +0000126#define SPI_STATISTICS_TRANSFER_BYTES_HISTO(index, number) \
127 SPI_STATISTICS_SHOW_NAME(transfer_bytes_histo##index, \
128 "transfer_bytes_histo_" number, \
129 transfer_bytes_histo[index], "%lu")
130SPI_STATISTICS_TRANSFER_BYTES_HISTO(0, "0-1");
131SPI_STATISTICS_TRANSFER_BYTES_HISTO(1, "2-3");
132SPI_STATISTICS_TRANSFER_BYTES_HISTO(2, "4-7");
133SPI_STATISTICS_TRANSFER_BYTES_HISTO(3, "8-15");
134SPI_STATISTICS_TRANSFER_BYTES_HISTO(4, "16-31");
135SPI_STATISTICS_TRANSFER_BYTES_HISTO(5, "32-63");
136SPI_STATISTICS_TRANSFER_BYTES_HISTO(6, "64-127");
137SPI_STATISTICS_TRANSFER_BYTES_HISTO(7, "128-255");
138SPI_STATISTICS_TRANSFER_BYTES_HISTO(8, "256-511");
139SPI_STATISTICS_TRANSFER_BYTES_HISTO(9, "512-1023");
140SPI_STATISTICS_TRANSFER_BYTES_HISTO(10, "1024-2047");
141SPI_STATISTICS_TRANSFER_BYTES_HISTO(11, "2048-4095");
142SPI_STATISTICS_TRANSFER_BYTES_HISTO(12, "4096-8191");
143SPI_STATISTICS_TRANSFER_BYTES_HISTO(13, "8192-16383");
144SPI_STATISTICS_TRANSFER_BYTES_HISTO(14, "16384-32767");
145SPI_STATISTICS_TRANSFER_BYTES_HISTO(15, "32768-65535");
146SPI_STATISTICS_TRANSFER_BYTES_HISTO(16, "65536+");
147
Martin Sperld9f12122015-12-14 15:20:20 +0000148SPI_STATISTICS_SHOW(transfers_split_maxsize, "%lu");
149
Greg Kroah-Hartmanaa7da562013-10-07 18:27:38 -0700150static struct attribute *spi_dev_attrs[] = {
151 &dev_attr_modalias.attr,
152 NULL,
David Brownell8ae12a02006-01-08 13:34:19 -0800153};
Martin Sperleca2ebc2015-06-22 13:00:36 +0000154
155static const struct attribute_group spi_dev_group = {
156 .attrs = spi_dev_attrs,
157};
158
159static struct attribute *spi_device_statistics_attrs[] = {
160 &dev_attr_spi_device_messages.attr,
161 &dev_attr_spi_device_transfers.attr,
162 &dev_attr_spi_device_errors.attr,
163 &dev_attr_spi_device_timedout.attr,
164 &dev_attr_spi_device_spi_sync.attr,
165 &dev_attr_spi_device_spi_sync_immediate.attr,
166 &dev_attr_spi_device_spi_async.attr,
167 &dev_attr_spi_device_bytes.attr,
168 &dev_attr_spi_device_bytes_rx.attr,
169 &dev_attr_spi_device_bytes_tx.attr,
Martin Sperl6b7bc062015-06-22 13:02:04 +0000170 &dev_attr_spi_device_transfer_bytes_histo0.attr,
171 &dev_attr_spi_device_transfer_bytes_histo1.attr,
172 &dev_attr_spi_device_transfer_bytes_histo2.attr,
173 &dev_attr_spi_device_transfer_bytes_histo3.attr,
174 &dev_attr_spi_device_transfer_bytes_histo4.attr,
175 &dev_attr_spi_device_transfer_bytes_histo5.attr,
176 &dev_attr_spi_device_transfer_bytes_histo6.attr,
177 &dev_attr_spi_device_transfer_bytes_histo7.attr,
178 &dev_attr_spi_device_transfer_bytes_histo8.attr,
179 &dev_attr_spi_device_transfer_bytes_histo9.attr,
180 &dev_attr_spi_device_transfer_bytes_histo10.attr,
181 &dev_attr_spi_device_transfer_bytes_histo11.attr,
182 &dev_attr_spi_device_transfer_bytes_histo12.attr,
183 &dev_attr_spi_device_transfer_bytes_histo13.attr,
184 &dev_attr_spi_device_transfer_bytes_histo14.attr,
185 &dev_attr_spi_device_transfer_bytes_histo15.attr,
186 &dev_attr_spi_device_transfer_bytes_histo16.attr,
Martin Sperld9f12122015-12-14 15:20:20 +0000187 &dev_attr_spi_device_transfers_split_maxsize.attr,
Martin Sperleca2ebc2015-06-22 13:00:36 +0000188 NULL,
189};
190
191static const struct attribute_group spi_device_statistics_group = {
192 .name = "statistics",
193 .attrs = spi_device_statistics_attrs,
194};
195
196static const struct attribute_group *spi_dev_groups[] = {
197 &spi_dev_group,
198 &spi_device_statistics_group,
199 NULL,
200};
201
202static struct attribute *spi_master_statistics_attrs[] = {
203 &dev_attr_spi_master_messages.attr,
204 &dev_attr_spi_master_transfers.attr,
205 &dev_attr_spi_master_errors.attr,
206 &dev_attr_spi_master_timedout.attr,
207 &dev_attr_spi_master_spi_sync.attr,
208 &dev_attr_spi_master_spi_sync_immediate.attr,
209 &dev_attr_spi_master_spi_async.attr,
210 &dev_attr_spi_master_bytes.attr,
211 &dev_attr_spi_master_bytes_rx.attr,
212 &dev_attr_spi_master_bytes_tx.attr,
Martin Sperl6b7bc062015-06-22 13:02:04 +0000213 &dev_attr_spi_master_transfer_bytes_histo0.attr,
214 &dev_attr_spi_master_transfer_bytes_histo1.attr,
215 &dev_attr_spi_master_transfer_bytes_histo2.attr,
216 &dev_attr_spi_master_transfer_bytes_histo3.attr,
217 &dev_attr_spi_master_transfer_bytes_histo4.attr,
218 &dev_attr_spi_master_transfer_bytes_histo5.attr,
219 &dev_attr_spi_master_transfer_bytes_histo6.attr,
220 &dev_attr_spi_master_transfer_bytes_histo7.attr,
221 &dev_attr_spi_master_transfer_bytes_histo8.attr,
222 &dev_attr_spi_master_transfer_bytes_histo9.attr,
223 &dev_attr_spi_master_transfer_bytes_histo10.attr,
224 &dev_attr_spi_master_transfer_bytes_histo11.attr,
225 &dev_attr_spi_master_transfer_bytes_histo12.attr,
226 &dev_attr_spi_master_transfer_bytes_histo13.attr,
227 &dev_attr_spi_master_transfer_bytes_histo14.attr,
228 &dev_attr_spi_master_transfer_bytes_histo15.attr,
229 &dev_attr_spi_master_transfer_bytes_histo16.attr,
Martin Sperld9f12122015-12-14 15:20:20 +0000230 &dev_attr_spi_master_transfers_split_maxsize.attr,
Martin Sperleca2ebc2015-06-22 13:00:36 +0000231 NULL,
232};
233
234static const struct attribute_group spi_master_statistics_group = {
235 .name = "statistics",
236 .attrs = spi_master_statistics_attrs,
237};
238
239static const struct attribute_group *spi_master_groups[] = {
240 &spi_master_statistics_group,
241 NULL,
242};
243
244void spi_statistics_add_transfer_stats(struct spi_statistics *stats,
245 struct spi_transfer *xfer,
246 struct spi_master *master)
247{
248 unsigned long flags;
Martin Sperl6b7bc062015-06-22 13:02:04 +0000249 int l2len = min(fls(xfer->len), SPI_STATISTICS_HISTO_SIZE) - 1;
250
251 if (l2len < 0)
252 l2len = 0;
Martin Sperleca2ebc2015-06-22 13:00:36 +0000253
254 spin_lock_irqsave(&stats->lock, flags);
255
256 stats->transfers++;
Martin Sperl6b7bc062015-06-22 13:02:04 +0000257 stats->transfer_bytes_histo[l2len]++;
Martin Sperleca2ebc2015-06-22 13:00:36 +0000258
259 stats->bytes += xfer->len;
260 if ((xfer->tx_buf) &&
261 (xfer->tx_buf != master->dummy_tx))
262 stats->bytes_tx += xfer->len;
263 if ((xfer->rx_buf) &&
264 (xfer->rx_buf != master->dummy_rx))
265 stats->bytes_rx += xfer->len;
266
267 spin_unlock_irqrestore(&stats->lock, flags);
268}
269EXPORT_SYMBOL_GPL(spi_statistics_add_transfer_stats);
David Brownell8ae12a02006-01-08 13:34:19 -0800270
271/* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
272 * and the sysfs version makes coldplug work too.
273 */
274
Anton Vorontsov75368bf2009-09-22 16:46:04 -0700275static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
276 const struct spi_device *sdev)
277{
278 while (id->name[0]) {
279 if (!strcmp(sdev->modalias, id->name))
280 return id;
281 id++;
282 }
283 return NULL;
284}
285
286const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
287{
288 const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
289
290 return spi_match_id(sdrv->id_table, sdev);
291}
292EXPORT_SYMBOL_GPL(spi_get_device_id);
293
David Brownell8ae12a02006-01-08 13:34:19 -0800294static int spi_match_device(struct device *dev, struct device_driver *drv)
295{
296 const struct spi_device *spi = to_spi_device(dev);
Anton Vorontsov75368bf2009-09-22 16:46:04 -0700297 const struct spi_driver *sdrv = to_spi_driver(drv);
298
Sinan Akman2b7a32f2010-10-02 21:28:29 -0600299 /* Attempt an OF style match */
300 if (of_driver_match_device(dev, drv))
301 return 1;
302
Mika Westerberg64bee4d2012-11-30 12:37:53 +0100303 /* Then try ACPI */
304 if (acpi_driver_match_device(dev, drv))
305 return 1;
306
Anton Vorontsov75368bf2009-09-22 16:46:04 -0700307 if (sdrv->id_table)
308 return !!spi_match_id(sdrv->id_table, spi);
David Brownell8ae12a02006-01-08 13:34:19 -0800309
Kay Sievers35f74fc2009-01-06 10:44:37 -0800310 return strcmp(spi->modalias, drv->name) == 0;
David Brownell8ae12a02006-01-08 13:34:19 -0800311}
312
Kay Sievers7eff2e72007-08-14 15:15:12 +0200313static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell8ae12a02006-01-08 13:34:19 -0800314{
315 const struct spi_device *spi = to_spi_device(dev);
Zhang Rui8c4ff6d2014-01-14 16:46:37 +0800316 int rc;
317
318 rc = acpi_device_uevent_modalias(dev, env);
319 if (rc != -ENODEV)
320 return rc;
David Brownell8ae12a02006-01-08 13:34:19 -0800321
Anton Vorontsove0626e32009-09-22 16:46:08 -0700322 add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
David Brownell8ae12a02006-01-08 13:34:19 -0800323 return 0;
324}
325
David Brownell8ae12a02006-01-08 13:34:19 -0800326struct bus_type spi_bus_type = {
327 .name = "spi",
Greg Kroah-Hartmanaa7da562013-10-07 18:27:38 -0700328 .dev_groups = spi_dev_groups,
David Brownell8ae12a02006-01-08 13:34:19 -0800329 .match = spi_match_device,
330 .uevent = spi_uevent,
David Brownell8ae12a02006-01-08 13:34:19 -0800331};
332EXPORT_SYMBOL_GPL(spi_bus_type);
333
David Brownellb8852442006-01-08 13:34:23 -0800334
335static int spi_drv_probe(struct device *dev)
336{
337 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
Jon Hunter44af7922015-10-09 15:45:55 +0100338 struct spi_device *spi = to_spi_device(dev);
Mika Westerberg33cf00e2013-10-10 13:28:48 +0300339 int ret;
David Brownellb8852442006-01-08 13:34:23 -0800340
Sylwester Nawrocki86be4082014-06-18 17:29:32 +0200341 ret = of_clk_set_defaults(dev->of_node, false);
342 if (ret)
343 return ret;
344
Jon Hunter44af7922015-10-09 15:45:55 +0100345 if (dev->of_node) {
346 spi->irq = of_irq_get(dev->of_node, 0);
347 if (spi->irq == -EPROBE_DEFER)
348 return -EPROBE_DEFER;
349 if (spi->irq < 0)
350 spi->irq = 0;
351 }
352
Ulf Hansson676e7c22014-09-19 20:27:41 +0200353 ret = dev_pm_domain_attach(dev, true);
354 if (ret != -EPROBE_DEFER) {
Jon Hunter44af7922015-10-09 15:45:55 +0100355 ret = sdrv->probe(spi);
Ulf Hansson676e7c22014-09-19 20:27:41 +0200356 if (ret)
357 dev_pm_domain_detach(dev, true);
358 }
Mika Westerberg33cf00e2013-10-10 13:28:48 +0300359
360 return ret;
David Brownellb8852442006-01-08 13:34:23 -0800361}
362
363static int spi_drv_remove(struct device *dev)
364{
365 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
Mika Westerberg33cf00e2013-10-10 13:28:48 +0300366 int ret;
David Brownellb8852442006-01-08 13:34:23 -0800367
Jean Delvareaec35f42014-02-13 15:28:41 +0100368 ret = sdrv->remove(to_spi_device(dev));
Ulf Hansson676e7c22014-09-19 20:27:41 +0200369 dev_pm_domain_detach(dev, true);
Mika Westerberg33cf00e2013-10-10 13:28:48 +0300370
371 return ret;
David Brownellb8852442006-01-08 13:34:23 -0800372}
373
374static void spi_drv_shutdown(struct device *dev)
375{
376 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
377
378 sdrv->shutdown(to_spi_device(dev));
379}
380
David Brownell33e34dc2007-05-08 00:32:21 -0700381/**
Andrew F. Davisca5d2482015-10-23 08:59:10 -0500382 * __spi_register_driver - register a SPI driver
Thierry Reding88c93212015-11-10 13:03:04 +0100383 * @owner: owner module of the driver to register
David Brownell33e34dc2007-05-08 00:32:21 -0700384 * @sdrv: the driver to register
385 * Context: can sleep
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200386 *
387 * Return: zero on success, else a negative error code.
David Brownell33e34dc2007-05-08 00:32:21 -0700388 */
Andrew F. Davisca5d2482015-10-23 08:59:10 -0500389int __spi_register_driver(struct module *owner, struct spi_driver *sdrv)
David Brownellb8852442006-01-08 13:34:23 -0800390{
Andrew F. Davisca5d2482015-10-23 08:59:10 -0500391 sdrv->driver.owner = owner;
David Brownellb8852442006-01-08 13:34:23 -0800392 sdrv->driver.bus = &spi_bus_type;
393 if (sdrv->probe)
394 sdrv->driver.probe = spi_drv_probe;
395 if (sdrv->remove)
396 sdrv->driver.remove = spi_drv_remove;
397 if (sdrv->shutdown)
398 sdrv->driver.shutdown = spi_drv_shutdown;
399 return driver_register(&sdrv->driver);
400}
Andrew F. Davisca5d2482015-10-23 08:59:10 -0500401EXPORT_SYMBOL_GPL(__spi_register_driver);
David Brownellb8852442006-01-08 13:34:23 -0800402
David Brownell8ae12a02006-01-08 13:34:19 -0800403/*-------------------------------------------------------------------------*/
404
405/* SPI devices should normally not be created by SPI device drivers; that
406 * would make them board-specific. Similarly with SPI master drivers.
407 * Device registration normally goes into like arch/.../mach.../board-YYY.c
408 * with other readonly (flashable) information about mainboard devices.
409 */
410
411struct boardinfo {
412 struct list_head list;
Feng Tang2b9603a2010-08-02 15:52:15 +0800413 struct spi_board_info board_info;
David Brownell8ae12a02006-01-08 13:34:19 -0800414};
415
416static LIST_HEAD(board_list);
Feng Tang2b9603a2010-08-02 15:52:15 +0800417static LIST_HEAD(spi_master_list);
418
419/*
420 * Used to protect add/del opertion for board_info list and
421 * spi_master list, and their matching process
422 */
Matthias Kaehlcke94040822007-07-17 04:04:16 -0700423static DEFINE_MUTEX(board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800424
Grant Likelydc87c982008-05-15 16:50:22 -0600425/**
426 * spi_alloc_device - Allocate a new SPI device
427 * @master: Controller to which device is connected
428 * Context: can sleep
429 *
430 * Allows a driver to allocate and initialize a spi_device without
431 * registering it immediately. This allows a driver to directly
432 * fill the spi_device with device parameters before calling
433 * spi_add_device() on it.
434 *
435 * Caller is responsible to call spi_add_device() on the returned
436 * spi_device structure to add it to the SPI master. If the caller
437 * needs to discard the spi_device without adding it, then it should
438 * call spi_dev_put() on it.
439 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200440 * Return: a pointer to the new device, or NULL.
Grant Likelydc87c982008-05-15 16:50:22 -0600441 */
442struct spi_device *spi_alloc_device(struct spi_master *master)
443{
444 struct spi_device *spi;
Grant Likelydc87c982008-05-15 16:50:22 -0600445
446 if (!spi_master_get(master))
447 return NULL;
448
Jingoo Han5fe5f052013-10-14 10:31:51 +0900449 spi = kzalloc(sizeof(*spi), GFP_KERNEL);
Grant Likelydc87c982008-05-15 16:50:22 -0600450 if (!spi) {
Grant Likelydc87c982008-05-15 16:50:22 -0600451 spi_master_put(master);
452 return NULL;
453 }
454
455 spi->master = master;
Laurent Pinchart178db7d2011-12-12 01:15:06 +0100456 spi->dev.parent = &master->dev;
Grant Likelydc87c982008-05-15 16:50:22 -0600457 spi->dev.bus = &spi_bus_type;
458 spi->dev.release = spidev_release;
Andreas Larsson446411e2013-02-13 14:20:25 +0100459 spi->cs_gpio = -ENOENT;
Martin Sperleca2ebc2015-06-22 13:00:36 +0000460
461 spin_lock_init(&spi->statistics.lock);
462
Grant Likelydc87c982008-05-15 16:50:22 -0600463 device_initialize(&spi->dev);
464 return spi;
465}
466EXPORT_SYMBOL_GPL(spi_alloc_device);
467
Jarkko Nikulae13ac472013-11-14 14:03:53 +0200468static void spi_dev_set_name(struct spi_device *spi)
469{
470 struct acpi_device *adev = ACPI_COMPANION(&spi->dev);
471
472 if (adev) {
473 dev_set_name(&spi->dev, "spi-%s", acpi_dev_name(adev));
474 return;
475 }
476
477 dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
478 spi->chip_select);
479}
480
Mika Westerbergb6fb8d32014-01-09 15:23:55 +0200481static int spi_dev_check(struct device *dev, void *data)
482{
483 struct spi_device *spi = to_spi_device(dev);
484 struct spi_device *new_spi = data;
485
486 if (spi->master == new_spi->master &&
487 spi->chip_select == new_spi->chip_select)
488 return -EBUSY;
489 return 0;
490}
491
Grant Likelydc87c982008-05-15 16:50:22 -0600492/**
493 * spi_add_device - Add spi_device allocated with spi_alloc_device
494 * @spi: spi_device to register
495 *
496 * Companion function to spi_alloc_device. Devices allocated with
497 * spi_alloc_device can be added onto the spi bus with this function.
498 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200499 * Return: 0 on success; negative errno on failure
Grant Likelydc87c982008-05-15 16:50:22 -0600500 */
501int spi_add_device(struct spi_device *spi)
502{
David Brownelle48880e2008-08-15 00:40:44 -0700503 static DEFINE_MUTEX(spi_add_lock);
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100504 struct spi_master *master = spi->master;
505 struct device *dev = master->dev.parent;
Grant Likelydc87c982008-05-15 16:50:22 -0600506 int status;
507
508 /* Chipselects are numbered 0..max; validate. */
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100509 if (spi->chip_select >= master->num_chipselect) {
Grant Likelydc87c982008-05-15 16:50:22 -0600510 dev_err(dev, "cs%d >= max %d\n",
511 spi->chip_select,
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100512 master->num_chipselect);
Grant Likelydc87c982008-05-15 16:50:22 -0600513 return -EINVAL;
514 }
515
516 /* Set the bus ID string */
Jarkko Nikulae13ac472013-11-14 14:03:53 +0200517 spi_dev_set_name(spi);
David Brownelle48880e2008-08-15 00:40:44 -0700518
519 /* We need to make sure there's no other device with this
520 * chipselect **BEFORE** we call setup(), else we'll trash
521 * its configuration. Lock against concurrent add() calls.
522 */
523 mutex_lock(&spi_add_lock);
524
Mika Westerbergb6fb8d32014-01-09 15:23:55 +0200525 status = bus_for_each_dev(&spi_bus_type, NULL, spi, spi_dev_check);
526 if (status) {
David Brownelle48880e2008-08-15 00:40:44 -0700527 dev_err(dev, "chipselect %d already in use\n",
528 spi->chip_select);
David Brownelle48880e2008-08-15 00:40:44 -0700529 goto done;
530 }
531
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100532 if (master->cs_gpios)
533 spi->cs_gpio = master->cs_gpios[spi->chip_select];
534
David Brownelle48880e2008-08-15 00:40:44 -0700535 /* Drivers may modify this initial i/o setup, but will
536 * normally rely on the device being setup. Devices
537 * using SPI_CS_HIGH can't coexist well otherwise...
538 */
David Brownell7d077192009-06-17 16:26:03 -0700539 status = spi_setup(spi);
Grant Likelydc87c982008-05-15 16:50:22 -0600540 if (status < 0) {
Linus Walleijeb288a12010-10-21 21:06:44 +0200541 dev_err(dev, "can't setup %s, status %d\n",
542 dev_name(&spi->dev), status);
David Brownelle48880e2008-08-15 00:40:44 -0700543 goto done;
Grant Likelydc87c982008-05-15 16:50:22 -0600544 }
545
David Brownelle48880e2008-08-15 00:40:44 -0700546 /* Device may be bound to an active driver when this returns */
Grant Likelydc87c982008-05-15 16:50:22 -0600547 status = device_add(&spi->dev);
David Brownelle48880e2008-08-15 00:40:44 -0700548 if (status < 0)
Linus Walleijeb288a12010-10-21 21:06:44 +0200549 dev_err(dev, "can't add %s, status %d\n",
550 dev_name(&spi->dev), status);
David Brownelle48880e2008-08-15 00:40:44 -0700551 else
Kay Sievers35f74fc2009-01-06 10:44:37 -0800552 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
Grant Likelydc87c982008-05-15 16:50:22 -0600553
David Brownelle48880e2008-08-15 00:40:44 -0700554done:
555 mutex_unlock(&spi_add_lock);
556 return status;
Grant Likelydc87c982008-05-15 16:50:22 -0600557}
558EXPORT_SYMBOL_GPL(spi_add_device);
David Brownell8ae12a02006-01-08 13:34:19 -0800559
David Brownell33e34dc2007-05-08 00:32:21 -0700560/**
561 * spi_new_device - instantiate one new SPI device
562 * @master: Controller to which device is connected
563 * @chip: Describes the SPI device
564 * Context: can sleep
565 *
566 * On typical mainboards, this is purely internal; and it's not needed
David Brownell8ae12a02006-01-08 13:34:19 -0800567 * after board init creates the hard-wired devices. Some development
568 * platforms may not be able to use spi_register_board_info though, and
569 * this is exported so that for example a USB or parport based adapter
570 * driver could add devices (which it would learn about out-of-band).
David Brownell082c8cb2007-07-31 00:39:45 -0700571 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +0200572 * Return: the new device, or NULL.
David Brownell8ae12a02006-01-08 13:34:19 -0800573 */
Adrian Bunke9d5a462007-03-26 21:32:23 -0800574struct spi_device *spi_new_device(struct spi_master *master,
575 struct spi_board_info *chip)
David Brownell8ae12a02006-01-08 13:34:19 -0800576{
577 struct spi_device *proxy;
David Brownell8ae12a02006-01-08 13:34:19 -0800578 int status;
579
David Brownell082c8cb2007-07-31 00:39:45 -0700580 /* NOTE: caller did any chip->bus_num checks necessary.
581 *
582 * Also, unless we change the return value convention to use
583 * error-or-pointer (not NULL-or-pointer), troubleshootability
584 * suggests syslogged diagnostics are best here (ugh).
585 */
586
Grant Likelydc87c982008-05-15 16:50:22 -0600587 proxy = spi_alloc_device(master);
588 if (!proxy)
David Brownell8ae12a02006-01-08 13:34:19 -0800589 return NULL;
590
Grant Likely102eb972008-07-23 21:29:55 -0700591 WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
592
David Brownell8ae12a02006-01-08 13:34:19 -0800593 proxy->chip_select = chip->chip_select;
594 proxy->max_speed_hz = chip->max_speed_hz;
David Brownell980a01c2006-06-28 07:47:15 -0700595 proxy->mode = chip->mode;
David Brownell8ae12a02006-01-08 13:34:19 -0800596 proxy->irq = chip->irq;
Grant Likely102eb972008-07-23 21:29:55 -0700597 strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
David Brownell8ae12a02006-01-08 13:34:19 -0800598 proxy->dev.platform_data = (void *) chip->platform_data;
599 proxy->controller_data = chip->controller_data;
600 proxy->controller_state = NULL;
David Brownell8ae12a02006-01-08 13:34:19 -0800601
Grant Likelydc87c982008-05-15 16:50:22 -0600602 status = spi_add_device(proxy);
David Brownell8ae12a02006-01-08 13:34:19 -0800603 if (status < 0) {
Grant Likelydc87c982008-05-15 16:50:22 -0600604 spi_dev_put(proxy);
605 return NULL;
David Brownell8ae12a02006-01-08 13:34:19 -0800606 }
607
David Brownell8ae12a02006-01-08 13:34:19 -0800608 return proxy;
609}
610EXPORT_SYMBOL_GPL(spi_new_device);
611
Geert Uytterhoeven3b1884c2015-11-30 15:28:06 +0100612/**
613 * spi_unregister_device - unregister a single SPI device
614 * @spi: spi_device to unregister
615 *
616 * Start making the passed SPI device vanish. Normally this would be handled
617 * by spi_unregister_master().
618 */
619void spi_unregister_device(struct spi_device *spi)
620{
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +0100621 if (!spi)
622 return;
623
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
Andy Shevchenko243f07b2015-10-20 12:28:29 +0300700 if (gpio_is_valid(spi->cs_gpio))
Mark Brownb1589352013-10-05 11:50:40 +0100701 gpio_set_value(spi->cs_gpio, !enable);
702 else if (spi->master->set_cs)
703 spi->master->set_cs(spi, !enable);
704}
705
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200706#ifdef CONFIG_HAS_DMA
Mark Brown6ad45a22014-02-02 13:47:47 +0000707static int spi_map_buf(struct spi_master *master, struct device *dev,
708 struct sg_table *sgt, void *buf, size_t len,
709 enum dma_data_direction dir)
710{
711 const bool vmalloced_buf = is_vmalloc_addr(buf);
Andy Shevchenkodf88e912016-03-09 11:20:00 +0200712 unsigned int max_seg_size = dma_get_max_seg_size(dev);
Vignesh Rb1b81532016-08-17 15:22:36 +0530713#ifdef CONFIG_HIGHMEM
714 const bool kmap_buf = ((unsigned long)buf >= PKMAP_BASE &&
715 (unsigned long)buf < (PKMAP_BASE +
716 (LAST_PKMAP * PAGE_SIZE)));
717#else
718 const bool kmap_buf = false;
719#endif
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500720 int desc_len;
721 int sgs;
Mark Brown6ad45a22014-02-02 13:47:47 +0000722 struct page *vm_page;
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600723 struct scatterlist *sg;
Mark Brown6ad45a22014-02-02 13:47:47 +0000724 void *sg_buf;
725 size_t min;
726 int i, ret;
727
Vignesh Rb1b81532016-08-17 15:22:36 +0530728 if (vmalloced_buf || kmap_buf) {
Andy Shevchenkodf88e912016-03-09 11:20:00 +0200729 desc_len = min_t(int, max_seg_size, PAGE_SIZE);
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500730 sgs = DIV_ROUND_UP(len + offset_in_page(buf), desc_len);
Vignesh R0569a882016-04-25 15:14:00 +0530731 } else if (virt_addr_valid(buf)) {
Andy Shevchenkodf88e912016-03-09 11:20:00 +0200732 desc_len = min_t(int, max_seg_size, master->max_dma_len);
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500733 sgs = DIV_ROUND_UP(len, desc_len);
Vignesh R0569a882016-04-25 15:14:00 +0530734 } else {
735 return -EINVAL;
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500736 }
737
Mark Brown6ad45a22014-02-02 13:47:47 +0000738 ret = sg_alloc_table(sgt, sgs, GFP_KERNEL);
739 if (ret != 0)
740 return ret;
741
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600742 sg = &sgt->sgl[0];
Mark Brown6ad45a22014-02-02 13:47:47 +0000743 for (i = 0; i < sgs; i++) {
Mark Brown6ad45a22014-02-02 13:47:47 +0000744
Vignesh Rb1b81532016-08-17 15:22:36 +0530745 if (vmalloced_buf || kmap_buf) {
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500746 min = min_t(size_t,
747 len, desc_len - offset_in_page(buf));
Vignesh Rb1b81532016-08-17 15:22:36 +0530748 if (vmalloced_buf)
749 vm_page = vmalloc_to_page(buf);
750 else
751 vm_page = kmap_to_page(buf);
Mark Brown6ad45a22014-02-02 13:47:47 +0000752 if (!vm_page) {
753 sg_free_table(sgt);
754 return -ENOMEM;
755 }
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600756 sg_set_page(sg, vm_page,
Charles Keepaxc1aefbd2014-11-17 09:14:31 +0000757 min, offset_in_page(buf));
Mark Brown6ad45a22014-02-02 13:47:47 +0000758 } else {
Andrew Gabbasov65598c12015-06-30 10:48:37 -0500759 min = min_t(size_t, len, desc_len);
Mark Brown6ad45a22014-02-02 13:47:47 +0000760 sg_buf = buf;
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600761 sg_set_buf(sg, sg_buf, min);
Mark Brown6ad45a22014-02-02 13:47:47 +0000762 }
763
Mark Brown6ad45a22014-02-02 13:47:47 +0000764 buf += min;
765 len -= min;
Juan Gutierrez8dd4a012016-11-21 16:50:03 -0600766 sg = sg_next(sg);
Mark Brown6ad45a22014-02-02 13:47:47 +0000767 }
768
769 ret = dma_map_sg(dev, sgt->sgl, sgt->nents, dir);
Geert Uytterhoeven89e4b662014-07-10 15:29:32 +0200770 if (!ret)
771 ret = -ENOMEM;
Mark Brown6ad45a22014-02-02 13:47:47 +0000772 if (ret < 0) {
773 sg_free_table(sgt);
774 return ret;
775 }
776
777 sgt->nents = ret;
778
779 return 0;
780}
781
782static void spi_unmap_buf(struct spi_master *master, struct device *dev,
783 struct sg_table *sgt, enum dma_data_direction dir)
784{
785 if (sgt->orig_nents) {
786 dma_unmap_sg(dev, sgt->sgl, sgt->orig_nents, dir);
787 sg_free_table(sgt);
788 }
789}
790
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200791static int __spi_map_msg(struct spi_master *master, struct spi_message *msg)
Mark Brown99adef32014-01-16 12:22:43 +0000792{
Mark Brown99adef32014-01-16 12:22:43 +0000793 struct device *tx_dev, *rx_dev;
794 struct spi_transfer *xfer;
Mark Brown6ad45a22014-02-02 13:47:47 +0000795 int ret;
Mark Brown3a2eba92014-01-28 20:17:03 +0000796
Mark Brown6ad45a22014-02-02 13:47:47 +0000797 if (!master->can_dma)
Mark Brown99adef32014-01-16 12:22:43 +0000798 return 0;
799
Leilk Liuc37f45b2015-07-23 17:10:40 +0800800 if (master->dma_tx)
801 tx_dev = master->dma_tx->device->dev;
802 else
803 tx_dev = &master->dev;
804
805 if (master->dma_rx)
806 rx_dev = master->dma_rx->device->dev;
807 else
808 rx_dev = &master->dev;
Mark Brown99adef32014-01-16 12:22:43 +0000809
810 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
811 if (!master->can_dma(master, msg->spi, xfer))
812 continue;
813
814 if (xfer->tx_buf != NULL) {
Mark Brown6ad45a22014-02-02 13:47:47 +0000815 ret = spi_map_buf(master, tx_dev, &xfer->tx_sg,
816 (void *)xfer->tx_buf, xfer->len,
817 DMA_TO_DEVICE);
818 if (ret != 0)
819 return ret;
Mark Brown99adef32014-01-16 12:22:43 +0000820 }
821
822 if (xfer->rx_buf != NULL) {
Mark Brown6ad45a22014-02-02 13:47:47 +0000823 ret = spi_map_buf(master, rx_dev, &xfer->rx_sg,
824 xfer->rx_buf, xfer->len,
825 DMA_FROM_DEVICE);
826 if (ret != 0) {
827 spi_unmap_buf(master, tx_dev, &xfer->tx_sg,
828 DMA_TO_DEVICE);
829 return ret;
Mark Brown99adef32014-01-16 12:22:43 +0000830 }
831 }
832 }
833
834 master->cur_msg_mapped = true;
835
836 return 0;
837}
838
Martin Sperl4b786452015-05-25 10:13:10 +0000839static int __spi_unmap_msg(struct spi_master *master, struct spi_message *msg)
Mark Brown99adef32014-01-16 12:22:43 +0000840{
841 struct spi_transfer *xfer;
842 struct device *tx_dev, *rx_dev;
843
Mark Brown6ad45a22014-02-02 13:47:47 +0000844 if (!master->cur_msg_mapped || !master->can_dma)
Mark Brown99adef32014-01-16 12:22:43 +0000845 return 0;
846
Leilk Liuc37f45b2015-07-23 17:10:40 +0800847 if (master->dma_tx)
848 tx_dev = master->dma_tx->device->dev;
849 else
850 tx_dev = &master->dev;
851
852 if (master->dma_rx)
853 rx_dev = master->dma_rx->device->dev;
854 else
855 rx_dev = &master->dev;
Mark Brown99adef32014-01-16 12:22:43 +0000856
857 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
858 if (!master->can_dma(master, msg->spi, xfer))
859 continue;
860
Mark Brown6ad45a22014-02-02 13:47:47 +0000861 spi_unmap_buf(master, rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
862 spi_unmap_buf(master, tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
Mark Brown99adef32014-01-16 12:22:43 +0000863 }
864
865 return 0;
866}
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200867#else /* !CONFIG_HAS_DMA */
Vignesh Rf4502dd2016-06-08 12:18:31 +0530868static inline int spi_map_buf(struct spi_master *master,
869 struct device *dev, struct sg_table *sgt,
870 void *buf, size_t len,
871 enum dma_data_direction dir)
872{
873 return -EINVAL;
874}
875
876static inline void spi_unmap_buf(struct spi_master *master,
877 struct device *dev, struct sg_table *sgt,
878 enum dma_data_direction dir)
879{
880}
881
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200882static inline int __spi_map_msg(struct spi_master *master,
883 struct spi_message *msg)
884{
885 return 0;
886}
887
Martin Sperl4b786452015-05-25 10:13:10 +0000888static inline int __spi_unmap_msg(struct spi_master *master,
889 struct spi_message *msg)
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200890{
891 return 0;
892}
893#endif /* !CONFIG_HAS_DMA */
894
Martin Sperl4b786452015-05-25 10:13:10 +0000895static inline int spi_unmap_msg(struct spi_master *master,
896 struct spi_message *msg)
897{
898 struct spi_transfer *xfer;
899
900 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
901 /*
902 * Restore the original value of tx_buf or rx_buf if they are
903 * NULL.
904 */
905 if (xfer->tx_buf == master->dummy_tx)
906 xfer->tx_buf = NULL;
907 if (xfer->rx_buf == master->dummy_rx)
908 xfer->rx_buf = NULL;
909 }
910
911 return __spi_unmap_msg(master, msg);
912}
913
Geert Uytterhoeven2de440f2014-05-02 06:29:34 +0200914static int spi_map_msg(struct spi_master *master, struct spi_message *msg)
915{
916 struct spi_transfer *xfer;
917 void *tmp;
918 unsigned int max_tx, max_rx;
919
920 if (master->flags & (SPI_MASTER_MUST_RX | SPI_MASTER_MUST_TX)) {
921 max_tx = 0;
922 max_rx = 0;
923
924 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
925 if ((master->flags & SPI_MASTER_MUST_TX) &&
926 !xfer->tx_buf)
927 max_tx = max(xfer->len, max_tx);
928 if ((master->flags & SPI_MASTER_MUST_RX) &&
929 !xfer->rx_buf)
930 max_rx = max(xfer->len, max_rx);
931 }
932
933 if (max_tx) {
934 tmp = krealloc(master->dummy_tx, max_tx,
935 GFP_KERNEL | GFP_DMA);
936 if (!tmp)
937 return -ENOMEM;
938 master->dummy_tx = tmp;
939 memset(tmp, 0, max_tx);
940 }
941
942 if (max_rx) {
943 tmp = krealloc(master->dummy_rx, max_rx,
944 GFP_KERNEL | GFP_DMA);
945 if (!tmp)
946 return -ENOMEM;
947 master->dummy_rx = tmp;
948 }
949
950 if (max_tx || max_rx) {
951 list_for_each_entry(xfer, &msg->transfers,
952 transfer_list) {
953 if (!xfer->tx_buf)
954 xfer->tx_buf = master->dummy_tx;
955 if (!xfer->rx_buf)
956 xfer->rx_buf = master->dummy_rx;
957 }
958 }
959 }
960
961 return __spi_map_msg(master, msg);
962}
Mark Brown99adef32014-01-16 12:22:43 +0000963
Mark Brownb1589352013-10-05 11:50:40 +0100964/*
965 * spi_transfer_one_message - Default implementation of transfer_one_message()
966 *
967 * This is a standard implementation of transfer_one_message() for
Moritz Fischer8ba811a2016-05-03 11:59:30 -0700968 * drivers which implement a transfer_one() operation. It provides
Mark Brownb1589352013-10-05 11:50:40 +0100969 * standard handling of delays and chip select management.
970 */
971static int spi_transfer_one_message(struct spi_master *master,
972 struct spi_message *msg)
973{
974 struct spi_transfer *xfer;
Mark Brownb1589352013-10-05 11:50:40 +0100975 bool keep_cs = false;
976 int ret = 0;
Sien Wud0716dd2016-09-01 18:24:29 -0500977 unsigned long long ms = 1;
Martin Sperleca2ebc2015-06-22 13:00:36 +0000978 struct spi_statistics *statm = &master->statistics;
979 struct spi_statistics *stats = &msg->spi->statistics;
Mark Brownb1589352013-10-05 11:50:40 +0100980
981 spi_set_cs(msg->spi, true);
982
Martin Sperleca2ebc2015-06-22 13:00:36 +0000983 SPI_STATISTICS_INCREMENT_FIELD(statm, messages);
984 SPI_STATISTICS_INCREMENT_FIELD(stats, messages);
985
Mark Brownb1589352013-10-05 11:50:40 +0100986 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
987 trace_spi_transfer_start(msg, xfer);
988
Martin Sperleca2ebc2015-06-22 13:00:36 +0000989 spi_statistics_add_transfer_stats(statm, xfer, master);
990 spi_statistics_add_transfer_stats(stats, xfer, master);
991
Mark Brown38ec10f2014-08-16 16:27:41 +0100992 if (xfer->tx_buf || xfer->rx_buf) {
993 reinit_completion(&master->xfer_completion);
Mark Brownb1589352013-10-05 11:50:40 +0100994
Mark Brown38ec10f2014-08-16 16:27:41 +0100995 ret = master->transfer_one(master, msg->spi, xfer);
996 if (ret < 0) {
Martin Sperleca2ebc2015-06-22 13:00:36 +0000997 SPI_STATISTICS_INCREMENT_FIELD(statm,
998 errors);
999 SPI_STATISTICS_INCREMENT_FIELD(stats,
1000 errors);
Mark Brown38ec10f2014-08-16 16:27:41 +01001001 dev_err(&msg->spi->dev,
1002 "SPI transfer failed: %d\n", ret);
1003 goto out;
1004 }
Mark Brownb1589352013-10-05 11:50:40 +01001005
Mark Brown38ec10f2014-08-16 16:27:41 +01001006 if (ret > 0) {
1007 ret = 0;
Sien Wud0716dd2016-09-01 18:24:29 -05001008 ms = 8LL * 1000LL * xfer->len;
1009 do_div(ms, xfer->speed_hz);
Mark Brown38ec10f2014-08-16 16:27:41 +01001010 ms += ms + 100; /* some tolerance */
Mark Brown16a0ce42014-01-30 22:16:41 +00001011
Sien Wud0716dd2016-09-01 18:24:29 -05001012 if (ms > UINT_MAX)
1013 ms = UINT_MAX;
1014
Mark Brown38ec10f2014-08-16 16:27:41 +01001015 ms = wait_for_completion_timeout(&master->xfer_completion,
1016 msecs_to_jiffies(ms));
1017 }
Mark Brown16a0ce42014-01-30 22:16:41 +00001018
Mark Brown38ec10f2014-08-16 16:27:41 +01001019 if (ms == 0) {
Martin Sperleca2ebc2015-06-22 13:00:36 +00001020 SPI_STATISTICS_INCREMENT_FIELD(statm,
1021 timedout);
1022 SPI_STATISTICS_INCREMENT_FIELD(stats,
1023 timedout);
Mark Brown38ec10f2014-08-16 16:27:41 +01001024 dev_err(&msg->spi->dev,
1025 "SPI transfer timed out\n");
1026 msg->status = -ETIMEDOUT;
1027 }
1028 } else {
1029 if (xfer->len)
1030 dev_err(&msg->spi->dev,
1031 "Bufferless transfer has length %u\n",
1032 xfer->len);
Axel Lin13a42792014-01-18 22:05:22 +08001033 }
Mark Brownb1589352013-10-05 11:50:40 +01001034
1035 trace_spi_transfer_stop(msg, xfer);
1036
1037 if (msg->status != -EINPROGRESS)
1038 goto out;
1039
1040 if (xfer->delay_usecs)
1041 udelay(xfer->delay_usecs);
1042
1043 if (xfer->cs_change) {
1044 if (list_is_last(&xfer->transfer_list,
1045 &msg->transfers)) {
1046 keep_cs = true;
1047 } else {
Mark Brown0b73aa62014-03-29 23:48:07 +00001048 spi_set_cs(msg->spi, false);
1049 udelay(10);
1050 spi_set_cs(msg->spi, true);
Mark Brownb1589352013-10-05 11:50:40 +01001051 }
1052 }
1053
1054 msg->actual_length += xfer->len;
1055 }
1056
1057out:
1058 if (ret != 0 || !keep_cs)
1059 spi_set_cs(msg->spi, false);
1060
1061 if (msg->status == -EINPROGRESS)
1062 msg->status = ret;
1063
Geert Uytterhoevenff61eb42015-04-07 20:39:19 +02001064 if (msg->status && master->handle_err)
Andy Shevchenkob716c4f2015-02-27 17:34:15 +02001065 master->handle_err(master, msg);
1066
Martin Sperld780c372015-12-14 15:20:18 +00001067 spi_res_release(master, msg);
1068
Mark Brownb1589352013-10-05 11:50:40 +01001069 spi_finalize_current_message(master);
1070
1071 return ret;
1072}
1073
1074/**
1075 * spi_finalize_current_transfer - report completion of a transfer
Thierry Reding2c675682014-08-08 13:02:36 +02001076 * @master: the master reporting completion
Mark Brownb1589352013-10-05 11:50:40 +01001077 *
1078 * Called by SPI drivers using the core transfer_one_message()
1079 * implementation to notify it that the current interrupt driven
Geert Uytterhoeven9e8f4882014-01-21 16:10:05 +01001080 * transfer has finished and the next one may be scheduled.
Mark Brownb1589352013-10-05 11:50:40 +01001081 */
1082void spi_finalize_current_transfer(struct spi_master *master)
1083{
1084 complete(&master->xfer_completion);
1085}
1086EXPORT_SYMBOL_GPL(spi_finalize_current_transfer);
1087
Linus Walleijffbbdd212012-02-22 10:05:38 +01001088/**
Mark Brownfc9e0f72014-12-10 13:46:33 +00001089 * __spi_pump_messages - function which processes spi message queue
1090 * @master: master to process queue for
1091 * @in_kthread: true if we are in the context of the message pump thread
Linus Walleijffbbdd212012-02-22 10:05:38 +01001092 *
1093 * This function checks if there is any spi message in the queue that
1094 * needs processing and if so call out to the driver to initialize hardware
1095 * and transfer each message.
1096 *
Mark Brown0461a412014-12-09 21:38:05 +00001097 * Note that it is called both from the kthread itself and also from
1098 * inside spi_sync(); the queue extraction handling at the top of the
1099 * function should deal with this safely.
Linus Walleijffbbdd212012-02-22 10:05:38 +01001100 */
Mark Brownef4d96e2016-07-21 23:53:31 +01001101static void __spi_pump_messages(struct spi_master *master, bool in_kthread)
Linus Walleijffbbdd212012-02-22 10:05:38 +01001102{
Linus Walleijffbbdd212012-02-22 10:05:38 +01001103 unsigned long flags;
1104 bool was_busy = false;
1105 int ret;
1106
Mark Brown983aee52014-12-09 19:46:56 +00001107 /* Lock queue */
Linus Walleijffbbdd212012-02-22 10:05:38 +01001108 spin_lock_irqsave(&master->queue_lock, flags);
Mark Brown983aee52014-12-09 19:46:56 +00001109
1110 /* Make sure we are not already running a message */
1111 if (master->cur_msg) {
1112 spin_unlock_irqrestore(&master->queue_lock, flags);
1113 return;
1114 }
1115
Mark Brown0461a412014-12-09 21:38:05 +00001116 /* If another context is idling the device then defer */
1117 if (master->idling) {
Petr Mladek39891442016-10-11 13:55:20 -07001118 kthread_queue_work(&master->kworker, &master->pump_messages);
Mark Brown0461a412014-12-09 21:38:05 +00001119 spin_unlock_irqrestore(&master->queue_lock, flags);
1120 return;
1121 }
1122
Mark Brown983aee52014-12-09 19:46:56 +00001123 /* Check if the queue is idle */
Linus Walleijffbbdd212012-02-22 10:05:38 +01001124 if (list_empty(&master->queue) || !master->running) {
Bryan Freedb0b36b82013-03-13 11:17:40 -07001125 if (!master->busy) {
1126 spin_unlock_irqrestore(&master->queue_lock, flags);
1127 return;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001128 }
Mark Brownfc9e0f72014-12-10 13:46:33 +00001129
1130 /* Only do teardown in the thread */
1131 if (!in_kthread) {
Petr Mladek39891442016-10-11 13:55:20 -07001132 kthread_queue_work(&master->kworker,
Mark Brownfc9e0f72014-12-10 13:46:33 +00001133 &master->pump_messages);
1134 spin_unlock_irqrestore(&master->queue_lock, flags);
1135 return;
1136 }
1137
Linus Walleijffbbdd212012-02-22 10:05:38 +01001138 master->busy = false;
Mark Brown0461a412014-12-09 21:38:05 +00001139 master->idling = true;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001140 spin_unlock_irqrestore(&master->queue_lock, flags);
Mark Brown0461a412014-12-09 21:38:05 +00001141
Mark Brown3a2eba92014-01-28 20:17:03 +00001142 kfree(master->dummy_rx);
1143 master->dummy_rx = NULL;
1144 kfree(master->dummy_tx);
1145 master->dummy_tx = NULL;
Bryan Freedb0b36b82013-03-13 11:17:40 -07001146 if (master->unprepare_transfer_hardware &&
1147 master->unprepare_transfer_hardware(master))
1148 dev_err(&master->dev,
1149 "failed to unprepare transfer hardware\n");
Mark Brown49834de2013-07-28 14:47:02 +01001150 if (master->auto_runtime_pm) {
1151 pm_runtime_mark_last_busy(master->dev.parent);
1152 pm_runtime_put_autosuspend(master->dev.parent);
1153 }
Mark Brown56ec1972013-10-07 19:33:53 +01001154 trace_spi_master_idle(master);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001155
Mark Brown0461a412014-12-09 21:38:05 +00001156 spin_lock_irqsave(&master->queue_lock, flags);
1157 master->idling = false;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001158 spin_unlock_irqrestore(&master->queue_lock, flags);
1159 return;
1160 }
Linus Walleijffbbdd212012-02-22 10:05:38 +01001161
Linus Walleijffbbdd212012-02-22 10:05:38 +01001162 /* Extract head of queue */
1163 master->cur_msg =
Axel Lina89e2d22014-01-09 16:03:58 +08001164 list_first_entry(&master->queue, struct spi_message, queue);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001165
1166 list_del_init(&master->cur_msg->queue);
1167 if (master->busy)
1168 was_busy = true;
1169 else
1170 master->busy = true;
1171 spin_unlock_irqrestore(&master->queue_lock, flags);
1172
Mark Brownef4d96e2016-07-21 23:53:31 +01001173 mutex_lock(&master->io_mutex);
1174
Mark Brown49834de2013-07-28 14:47:02 +01001175 if (!was_busy && master->auto_runtime_pm) {
1176 ret = pm_runtime_get_sync(master->dev.parent);
1177 if (ret < 0) {
1178 dev_err(&master->dev, "Failed to power device: %d\n",
1179 ret);
Mark Brown764f2162016-08-09 17:45:33 +01001180 mutex_unlock(&master->io_mutex);
Mark Brown49834de2013-07-28 14:47:02 +01001181 return;
1182 }
1183 }
1184
Mark Brown56ec1972013-10-07 19:33:53 +01001185 if (!was_busy)
1186 trace_spi_master_busy(master);
1187
Shubhrajyoti D7dfd2bd2012-05-10 19:20:41 +05301188 if (!was_busy && master->prepare_transfer_hardware) {
Linus Walleijffbbdd212012-02-22 10:05:38 +01001189 ret = master->prepare_transfer_hardware(master);
1190 if (ret) {
1191 dev_err(&master->dev,
1192 "failed to prepare transfer hardware\n");
Mark Brown49834de2013-07-28 14:47:02 +01001193
1194 if (master->auto_runtime_pm)
1195 pm_runtime_put(master->dev.parent);
Mark Brown764f2162016-08-09 17:45:33 +01001196 mutex_unlock(&master->io_mutex);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001197 return;
1198 }
1199 }
1200
Mark Brown56ec1972013-10-07 19:33:53 +01001201 trace_spi_message_start(master->cur_msg);
1202
Mark Brown2841a5f2013-10-05 00:23:12 +01001203 if (master->prepare_message) {
1204 ret = master->prepare_message(master, master->cur_msg);
1205 if (ret) {
1206 dev_err(&master->dev,
1207 "failed to prepare message: %d\n", ret);
1208 master->cur_msg->status = ret;
1209 spi_finalize_current_message(master);
Jon Hunter49023d22016-03-08 12:28:20 +00001210 goto out;
Mark Brown2841a5f2013-10-05 00:23:12 +01001211 }
1212 master->cur_msg_prepared = true;
1213 }
1214
Mark Brown99adef32014-01-16 12:22:43 +00001215 ret = spi_map_msg(master, master->cur_msg);
1216 if (ret) {
1217 master->cur_msg->status = ret;
1218 spi_finalize_current_message(master);
Jon Hunter49023d22016-03-08 12:28:20 +00001219 goto out;
Mark Brown99adef32014-01-16 12:22:43 +00001220 }
1221
Linus Walleijffbbdd212012-02-22 10:05:38 +01001222 ret = master->transfer_one_message(master, master->cur_msg);
1223 if (ret) {
1224 dev_err(&master->dev,
Geert Uytterhoeven1f802f82014-01-28 10:33:03 +01001225 "failed to transfer one message from queue\n");
Jon Hunter49023d22016-03-08 12:28:20 +00001226 goto out;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001227 }
Jon Hunter49023d22016-03-08 12:28:20 +00001228
1229out:
Mark Brownef4d96e2016-07-21 23:53:31 +01001230 mutex_unlock(&master->io_mutex);
Mark Brown62826972016-02-15 18:28:02 +00001231
1232 /* Prod the scheduler in case transfer_one() was busy waiting */
Jon Hunter49023d22016-03-08 12:28:20 +00001233 if (!ret)
1234 cond_resched();
Linus Walleijffbbdd212012-02-22 10:05:38 +01001235}
1236
Mark Brownfc9e0f72014-12-10 13:46:33 +00001237/**
1238 * spi_pump_messages - kthread work function which processes spi message queue
1239 * @work: pointer to kthread work struct contained in the master struct
1240 */
1241static void spi_pump_messages(struct kthread_work *work)
1242{
1243 struct spi_master *master =
1244 container_of(work, struct spi_master, pump_messages);
1245
Mark Brownef4d96e2016-07-21 23:53:31 +01001246 __spi_pump_messages(master, true);
Mark Brownfc9e0f72014-12-10 13:46:33 +00001247}
1248
Linus Walleijffbbdd212012-02-22 10:05:38 +01001249static int spi_init_queue(struct spi_master *master)
1250{
1251 struct sched_param param = { .sched_priority = MAX_RT_PRIO - 1 };
1252
Linus Walleijffbbdd212012-02-22 10:05:38 +01001253 master->running = false;
1254 master->busy = false;
1255
Petr Mladek39891442016-10-11 13:55:20 -07001256 kthread_init_worker(&master->kworker);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001257 master->kworker_task = kthread_run(kthread_worker_fn,
Kees Cookf1701682013-07-03 15:04:58 -07001258 &master->kworker, "%s",
Linus Walleijffbbdd212012-02-22 10:05:38 +01001259 dev_name(&master->dev));
1260 if (IS_ERR(master->kworker_task)) {
1261 dev_err(&master->dev, "failed to create message pump task\n");
Jarkko Nikula98a8f5a2014-12-04 11:02:25 +02001262 return PTR_ERR(master->kworker_task);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001263 }
Petr Mladek39891442016-10-11 13:55:20 -07001264 kthread_init_work(&master->pump_messages, spi_pump_messages);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001265
1266 /*
1267 * Master config will indicate if this controller should run the
1268 * message pump with high (realtime) priority to reduce the transfer
1269 * latency on the bus by minimising the delay between a transfer
1270 * request and the scheduling of the message pump thread. Without this
1271 * setting the message pump thread will remain at default priority.
1272 */
1273 if (master->rt) {
1274 dev_info(&master->dev,
1275 "will run message pump with realtime priority\n");
1276 sched_setscheduler(master->kworker_task, SCHED_FIFO, &param);
1277 }
1278
1279 return 0;
1280}
1281
1282/**
1283 * spi_get_next_queued_message() - called by driver to check for queued
1284 * messages
1285 * @master: the master to check for queued messages
1286 *
1287 * If there are more messages in the queue, the next message is returned from
1288 * this call.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001289 *
1290 * Return: the next message in the queue, else NULL if the queue is empty.
Linus Walleijffbbdd212012-02-22 10:05:38 +01001291 */
1292struct spi_message *spi_get_next_queued_message(struct spi_master *master)
1293{
1294 struct spi_message *next;
1295 unsigned long flags;
1296
1297 /* get a pointer to the next message, if any */
1298 spin_lock_irqsave(&master->queue_lock, flags);
Axel Lin1cfd97f2014-01-02 15:16:40 +08001299 next = list_first_entry_or_null(&master->queue, struct spi_message,
1300 queue);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001301 spin_unlock_irqrestore(&master->queue_lock, flags);
1302
1303 return next;
1304}
1305EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
1306
1307/**
1308 * spi_finalize_current_message() - the current message is complete
1309 * @master: the master to return the message to
1310 *
1311 * Called by the driver to notify the core that the message in the front of the
1312 * queue is complete and can be removed from the queue.
1313 */
1314void spi_finalize_current_message(struct spi_master *master)
1315{
1316 struct spi_message *mesg;
1317 unsigned long flags;
Mark Brown2841a5f2013-10-05 00:23:12 +01001318 int ret;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001319
1320 spin_lock_irqsave(&master->queue_lock, flags);
1321 mesg = master->cur_msg;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001322 spin_unlock_irqrestore(&master->queue_lock, flags);
1323
Mark Brown99adef32014-01-16 12:22:43 +00001324 spi_unmap_msg(master, mesg);
1325
Mark Brown2841a5f2013-10-05 00:23:12 +01001326 if (master->cur_msg_prepared && master->unprepare_message) {
1327 ret = master->unprepare_message(master, mesg);
1328 if (ret) {
1329 dev_err(&master->dev,
1330 "failed to unprepare message: %d\n", ret);
1331 }
1332 }
Uwe Kleine-König391949b2015-03-18 11:27:28 +01001333
Martin Sperl8e76ef82015-05-10 07:50:45 +00001334 spin_lock_irqsave(&master->queue_lock, flags);
1335 master->cur_msg = NULL;
Mark Brown2841a5f2013-10-05 00:23:12 +01001336 master->cur_msg_prepared = false;
Petr Mladek39891442016-10-11 13:55:20 -07001337 kthread_queue_work(&master->kworker, &master->pump_messages);
Martin Sperl8e76ef82015-05-10 07:50:45 +00001338 spin_unlock_irqrestore(&master->queue_lock, flags);
1339
1340 trace_spi_message_done(mesg);
Mark Brown2841a5f2013-10-05 00:23:12 +01001341
Linus Walleijffbbdd212012-02-22 10:05:38 +01001342 mesg->state = NULL;
1343 if (mesg->complete)
1344 mesg->complete(mesg->context);
1345}
1346EXPORT_SYMBOL_GPL(spi_finalize_current_message);
1347
1348static int spi_start_queue(struct spi_master *master)
1349{
1350 unsigned long flags;
1351
1352 spin_lock_irqsave(&master->queue_lock, flags);
1353
1354 if (master->running || master->busy) {
1355 spin_unlock_irqrestore(&master->queue_lock, flags);
1356 return -EBUSY;
1357 }
1358
1359 master->running = true;
1360 master->cur_msg = NULL;
1361 spin_unlock_irqrestore(&master->queue_lock, flags);
1362
Petr Mladek39891442016-10-11 13:55:20 -07001363 kthread_queue_work(&master->kworker, &master->pump_messages);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001364
1365 return 0;
1366}
1367
1368static int spi_stop_queue(struct spi_master *master)
1369{
1370 unsigned long flags;
1371 unsigned limit = 500;
1372 int ret = 0;
1373
1374 spin_lock_irqsave(&master->queue_lock, flags);
1375
1376 /*
1377 * This is a bit lame, but is optimized for the common execution path.
1378 * A wait_queue on the master->busy could be used, but then the common
1379 * execution path (pump_messages) would be required to call wake_up or
1380 * friends on every SPI message. Do this instead.
1381 */
1382 while ((!list_empty(&master->queue) || master->busy) && limit--) {
1383 spin_unlock_irqrestore(&master->queue_lock, flags);
Axel Linf97b26b2014-02-21 09:15:18 +08001384 usleep_range(10000, 11000);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001385 spin_lock_irqsave(&master->queue_lock, flags);
1386 }
1387
1388 if (!list_empty(&master->queue) || master->busy)
1389 ret = -EBUSY;
1390 else
1391 master->running = false;
1392
1393 spin_unlock_irqrestore(&master->queue_lock, flags);
1394
1395 if (ret) {
1396 dev_warn(&master->dev,
1397 "could not stop message queue\n");
1398 return ret;
1399 }
1400 return ret;
1401}
1402
1403static int spi_destroy_queue(struct spi_master *master)
1404{
1405 int ret;
1406
1407 ret = spi_stop_queue(master);
1408
1409 /*
Petr Mladek39891442016-10-11 13:55:20 -07001410 * kthread_flush_worker will block until all work is done.
Linus Walleijffbbdd212012-02-22 10:05:38 +01001411 * If the reason that stop_queue timed out is that the work will never
1412 * finish, then it does no good to call flush/stop thread, so
1413 * return anyway.
1414 */
1415 if (ret) {
1416 dev_err(&master->dev, "problem destroying queue\n");
1417 return ret;
1418 }
1419
Petr Mladek39891442016-10-11 13:55:20 -07001420 kthread_flush_worker(&master->kworker);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001421 kthread_stop(master->kworker_task);
1422
1423 return 0;
1424}
1425
Mark Brown0461a412014-12-09 21:38:05 +00001426static int __spi_queued_transfer(struct spi_device *spi,
1427 struct spi_message *msg,
1428 bool need_pump)
Linus Walleijffbbdd212012-02-22 10:05:38 +01001429{
1430 struct spi_master *master = spi->master;
1431 unsigned long flags;
1432
1433 spin_lock_irqsave(&master->queue_lock, flags);
1434
1435 if (!master->running) {
1436 spin_unlock_irqrestore(&master->queue_lock, flags);
1437 return -ESHUTDOWN;
1438 }
1439 msg->actual_length = 0;
1440 msg->status = -EINPROGRESS;
1441
1442 list_add_tail(&msg->queue, &master->queue);
Mark Brown0461a412014-12-09 21:38:05 +00001443 if (!master->busy && need_pump)
Petr Mladek39891442016-10-11 13:55:20 -07001444 kthread_queue_work(&master->kworker, &master->pump_messages);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001445
1446 spin_unlock_irqrestore(&master->queue_lock, flags);
1447 return 0;
1448}
1449
Mark Brown0461a412014-12-09 21:38:05 +00001450/**
1451 * spi_queued_transfer - transfer function for queued transfers
1452 * @spi: spi device which is requesting transfer
1453 * @msg: spi message which is to handled is queued to driver queue
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001454 *
1455 * Return: zero on success, else a negative error code.
Mark Brown0461a412014-12-09 21:38:05 +00001456 */
1457static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
1458{
1459 return __spi_queued_transfer(spi, msg, true);
1460}
1461
Linus Walleijffbbdd212012-02-22 10:05:38 +01001462static int spi_master_initialize_queue(struct spi_master *master)
1463{
1464 int ret;
1465
Linus Walleijffbbdd212012-02-22 10:05:38 +01001466 master->transfer = spi_queued_transfer;
Mark Brownb1589352013-10-05 11:50:40 +01001467 if (!master->transfer_one_message)
1468 master->transfer_one_message = spi_transfer_one_message;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001469
1470 /* Initialize and start queue */
1471 ret = spi_init_queue(master);
1472 if (ret) {
1473 dev_err(&master->dev, "problem initializing queue\n");
1474 goto err_init_queue;
1475 }
Mark Brownc3676d52014-05-01 10:47:52 -07001476 master->queued = true;
Linus Walleijffbbdd212012-02-22 10:05:38 +01001477 ret = spi_start_queue(master);
1478 if (ret) {
1479 dev_err(&master->dev, "problem starting queue\n");
1480 goto err_start_queue;
1481 }
1482
1483 return 0;
1484
1485err_start_queue:
Linus Walleijffbbdd212012-02-22 10:05:38 +01001486 spi_destroy_queue(master);
Mark Brownc3676d52014-05-01 10:47:52 -07001487err_init_queue:
Linus Walleijffbbdd212012-02-22 10:05:38 +01001488 return ret;
1489}
1490
1491/*-------------------------------------------------------------------------*/
1492
Andreas Larsson7cb94362012-12-04 15:09:38 +01001493#if defined(CONFIG_OF)
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001494static struct spi_device *
1495of_register_spi_device(struct spi_master *master, struct device_node *nc)
1496{
1497 struct spi_device *spi;
1498 int rc;
1499 u32 value;
1500
1501 /* Alloc an spi_device */
1502 spi = spi_alloc_device(master);
1503 if (!spi) {
1504 dev_err(&master->dev, "spi_device alloc error for %s\n",
1505 nc->full_name);
1506 rc = -ENOMEM;
1507 goto err_out;
1508 }
1509
1510 /* Select device driver */
1511 rc = of_modalias_node(nc, spi->modalias,
1512 sizeof(spi->modalias));
1513 if (rc < 0) {
1514 dev_err(&master->dev, "cannot find modalias for %s\n",
1515 nc->full_name);
1516 goto err_out;
1517 }
1518
1519 /* Device address */
1520 rc = of_property_read_u32(nc, "reg", &value);
1521 if (rc) {
1522 dev_err(&master->dev, "%s has no valid 'reg' property (%d)\n",
1523 nc->full_name, rc);
1524 goto err_out;
1525 }
1526 spi->chip_select = value;
1527
1528 /* Mode (clock phase/polarity/etc.) */
1529 if (of_find_property(nc, "spi-cpha", NULL))
1530 spi->mode |= SPI_CPHA;
1531 if (of_find_property(nc, "spi-cpol", NULL))
1532 spi->mode |= SPI_CPOL;
1533 if (of_find_property(nc, "spi-cs-high", NULL))
1534 spi->mode |= SPI_CS_HIGH;
1535 if (of_find_property(nc, "spi-3wire", NULL))
1536 spi->mode |= SPI_3WIRE;
1537 if (of_find_property(nc, "spi-lsb-first", NULL))
1538 spi->mode |= SPI_LSB_FIRST;
1539
1540 /* Device DUAL/QUAD mode */
1541 if (!of_property_read_u32(nc, "spi-tx-bus-width", &value)) {
1542 switch (value) {
1543 case 1:
1544 break;
1545 case 2:
1546 spi->mode |= SPI_TX_DUAL;
1547 break;
1548 case 4:
1549 spi->mode |= SPI_TX_QUAD;
1550 break;
1551 default:
1552 dev_warn(&master->dev,
1553 "spi-tx-bus-width %d not supported\n",
1554 value);
1555 break;
1556 }
1557 }
1558
1559 if (!of_property_read_u32(nc, "spi-rx-bus-width", &value)) {
1560 switch (value) {
1561 case 1:
1562 break;
1563 case 2:
1564 spi->mode |= SPI_RX_DUAL;
1565 break;
1566 case 4:
1567 spi->mode |= SPI_RX_QUAD;
1568 break;
1569 default:
1570 dev_warn(&master->dev,
1571 "spi-rx-bus-width %d not supported\n",
1572 value);
1573 break;
1574 }
1575 }
1576
1577 /* Device speed */
1578 rc = of_property_read_u32(nc, "spi-max-frequency", &value);
1579 if (rc) {
1580 dev_err(&master->dev, "%s has no valid 'spi-max-frequency' property (%d)\n",
1581 nc->full_name, rc);
1582 goto err_out;
1583 }
1584 spi->max_speed_hz = value;
1585
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001586 /* Store a pointer to the node in the device structure */
1587 of_node_get(nc);
1588 spi->dev.of_node = nc;
1589
1590 /* Register the new device */
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001591 rc = spi_add_device(spi);
1592 if (rc) {
1593 dev_err(&master->dev, "spi_device register error %s\n",
1594 nc->full_name);
1595 goto err_out;
1596 }
1597
1598 return spi;
1599
1600err_out:
1601 spi_dev_put(spi);
1602 return ERR_PTR(rc);
1603}
1604
Grant Likelyd57a4282012-04-07 14:16:53 -06001605/**
1606 * of_register_spi_devices() - Register child devices onto the SPI bus
1607 * @master: Pointer to spi_master device
1608 *
1609 * Registers an spi_device for each child node of master node which has a 'reg'
1610 * property.
1611 */
1612static void of_register_spi_devices(struct spi_master *master)
1613{
1614 struct spi_device *spi;
1615 struct device_node *nc;
Grant Likelyd57a4282012-04-07 14:16:53 -06001616
1617 if (!master->dev.of_node)
1618 return;
1619
Alexander Sverdlinf3b61592012-11-29 08:59:29 +01001620 for_each_available_child_of_node(master->dev.of_node, nc) {
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +01001621 if (of_node_test_and_set_flag(nc, OF_POPULATED))
1622 continue;
Pantelis Antoniouaff5e3f2014-10-29 10:40:37 +02001623 spi = of_register_spi_device(master, nc);
1624 if (IS_ERR(spi))
1625 dev_warn(&master->dev, "Failed to create SPI device for %s\n",
Grant Likelyd57a4282012-04-07 14:16:53 -06001626 nc->full_name);
Grant Likelyd57a4282012-04-07 14:16:53 -06001627 }
1628}
1629#else
1630static void of_register_spi_devices(struct spi_master *master) { }
1631#endif
1632
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001633#ifdef CONFIG_ACPI
1634static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
1635{
1636 struct spi_device *spi = data;
Mika Westerberga0a90712016-02-08 17:14:28 +02001637 struct spi_master *master = spi->master;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001638
1639 if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
1640 struct acpi_resource_spi_serialbus *sb;
1641
1642 sb = &ares->data.spi_serial_bus;
1643 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
Mika Westerberga0a90712016-02-08 17:14:28 +02001644 /*
1645 * ACPI DeviceSelection numbering is handled by the
1646 * host controller driver in Windows and can vary
1647 * from driver to driver. In Linux we always expect
1648 * 0 .. max - 1 so we need to ask the driver to
1649 * translate between the two schemes.
1650 */
1651 if (master->fw_translate_cs) {
1652 int cs = master->fw_translate_cs(master,
1653 sb->device_selection);
1654 if (cs < 0)
1655 return cs;
1656 spi->chip_select = cs;
1657 } else {
1658 spi->chip_select = sb->device_selection;
1659 }
1660
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001661 spi->max_speed_hz = sb->connection_speed;
1662
1663 if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
1664 spi->mode |= SPI_CPHA;
1665 if (sb->clock_polarity == ACPI_SPI_START_HIGH)
1666 spi->mode |= SPI_CPOL;
1667 if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
1668 spi->mode |= SPI_CS_HIGH;
1669 }
1670 } else if (spi->irq < 0) {
1671 struct resource r;
1672
1673 if (acpi_dev_resource_interrupt(ares, 0, &r))
1674 spi->irq = r.start;
1675 }
1676
1677 /* Always tell the ACPI core to skip this resource */
1678 return 1;
1679}
1680
Octavian Purdila7f244672016-07-08 19:13:11 +03001681static acpi_status acpi_register_spi_device(struct spi_master *master,
1682 struct acpi_device *adev)
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001683{
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001684 struct list_head resource_list;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001685 struct spi_device *spi;
1686 int ret;
1687
Octavian Purdila7f244672016-07-08 19:13:11 +03001688 if (acpi_bus_get_status(adev) || !adev->status.present ||
1689 acpi_device_enumerated(adev))
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001690 return AE_OK;
1691
1692 spi = spi_alloc_device(master);
1693 if (!spi) {
1694 dev_err(&master->dev, "failed to allocate SPI device for %s\n",
1695 dev_name(&adev->dev));
1696 return AE_NO_MEMORY;
1697 }
1698
Rafael J. Wysocki7b199812013-11-11 22:41:56 +01001699 ACPI_COMPANION_SET(&spi->dev, adev);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001700 spi->irq = -1;
1701
1702 INIT_LIST_HEAD(&resource_list);
1703 ret = acpi_dev_get_resources(adev, &resource_list,
1704 acpi_spi_add_resource, spi);
1705 acpi_dev_free_resource_list(&resource_list);
1706
1707 if (ret < 0 || !spi->max_speed_hz) {
1708 spi_dev_put(spi);
1709 return AE_OK;
1710 }
1711
Christophe RICARD33ada672015-12-23 23:25:35 +01001712 if (spi->irq < 0)
1713 spi->irq = acpi_dev_gpio_irq_get(adev, 0);
1714
Octavian Purdila7f244672016-07-08 19:13:11 +03001715 acpi_device_set_enumerated(adev);
1716
Mika Westerberg33cf00e2013-10-10 13:28:48 +03001717 adev->power.flags.ignore_parent = true;
Jarkko Nikulacf9eb392013-10-10 17:19:17 +03001718 strlcpy(spi->modalias, acpi_device_hid(adev), sizeof(spi->modalias));
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001719 if (spi_add_device(spi)) {
Mika Westerberg33cf00e2013-10-10 13:28:48 +03001720 adev->power.flags.ignore_parent = false;
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001721 dev_err(&master->dev, "failed to add SPI device %s from ACPI\n",
1722 dev_name(&adev->dev));
1723 spi_dev_put(spi);
1724 }
1725
1726 return AE_OK;
1727}
1728
Octavian Purdila7f244672016-07-08 19:13:11 +03001729static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
1730 void *data, void **return_value)
1731{
1732 struct spi_master *master = data;
1733 struct acpi_device *adev;
1734
1735 if (acpi_bus_get_device(handle, &adev))
1736 return AE_OK;
1737
1738 return acpi_register_spi_device(master, adev);
1739}
1740
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001741static void acpi_register_spi_devices(struct spi_master *master)
1742{
1743 acpi_status status;
1744 acpi_handle handle;
1745
Rafael J. Wysocki29896172013-04-01 00:21:08 +00001746 handle = ACPI_HANDLE(master->dev.parent);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001747 if (!handle)
1748 return;
1749
1750 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
1751 acpi_spi_add_device, NULL,
1752 master, NULL);
1753 if (ACPI_FAILURE(status))
1754 dev_warn(&master->dev, "failed to enumerate SPI slaves\n");
1755}
1756#else
1757static inline void acpi_register_spi_devices(struct spi_master *master) {}
1758#endif /* CONFIG_ACPI */
1759
Tony Jones49dce682007-10-16 01:27:48 -07001760static void spi_master_release(struct device *dev)
David Brownell8ae12a02006-01-08 13:34:19 -08001761{
1762 struct spi_master *master;
1763
Tony Jones49dce682007-10-16 01:27:48 -07001764 master = container_of(dev, struct spi_master, dev);
David Brownell8ae12a02006-01-08 13:34:19 -08001765 kfree(master);
1766}
1767
1768static struct class spi_master_class = {
1769 .name = "spi_master",
1770 .owner = THIS_MODULE,
Tony Jones49dce682007-10-16 01:27:48 -07001771 .dev_release = spi_master_release,
Martin Sperleca2ebc2015-06-22 13:00:36 +00001772 .dev_groups = spi_master_groups,
David Brownell8ae12a02006-01-08 13:34:19 -08001773};
1774
1775
1776/**
1777 * spi_alloc_master - allocate SPI master controller
1778 * @dev: the controller, possibly using the platform_bus
David Brownell33e34dc2007-05-08 00:32:21 -07001779 * @size: how much zeroed driver-private data to allocate; the pointer to this
Tony Jones49dce682007-10-16 01:27:48 -07001780 * memory is in the driver_data field of the returned device,
David Brownell0c868462006-01-08 13:34:25 -08001781 * accessible with spi_master_get_devdata().
David Brownell33e34dc2007-05-08 00:32:21 -07001782 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001783 *
1784 * This call is used only by SPI master controller drivers, which are the
1785 * only ones directly touching chip registers. It's how they allocate
dmitry pervushinba1a0512006-05-20 15:00:14 -07001786 * an spi_master structure, prior to calling spi_register_master().
David Brownell8ae12a02006-01-08 13:34:19 -08001787 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001788 * This must be called from context that can sleep.
David Brownell8ae12a02006-01-08 13:34:19 -08001789 *
1790 * The caller is responsible for assigning the bus number and initializing
dmitry pervushinba1a0512006-05-20 15:00:14 -07001791 * the master's methods before calling spi_register_master(); and (after errors
Guenter Roecka394d632015-09-06 01:46:54 +03001792 * adding the device) calling spi_master_put() to prevent a memory leak.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001793 *
1794 * Return: the SPI master structure on success, else NULL.
David Brownell8ae12a02006-01-08 13:34:19 -08001795 */
Adrian Bunke9d5a462007-03-26 21:32:23 -08001796struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
David Brownell8ae12a02006-01-08 13:34:19 -08001797{
1798 struct spi_master *master;
1799
David Brownell0c868462006-01-08 13:34:25 -08001800 if (!dev)
1801 return NULL;
1802
Jingoo Han5fe5f052013-10-14 10:31:51 +09001803 master = kzalloc(size + sizeof(*master), GFP_KERNEL);
David Brownell8ae12a02006-01-08 13:34:19 -08001804 if (!master)
1805 return NULL;
1806
Tony Jones49dce682007-10-16 01:27:48 -07001807 device_initialize(&master->dev);
Grant Likely1e8a52e2012-05-19 23:42:08 -06001808 master->bus_num = -1;
1809 master->num_chipselect = 1;
Tony Jones49dce682007-10-16 01:27:48 -07001810 master->dev.class = &spi_master_class;
Johan Hovold157f38f2015-12-14 16:16:19 +01001811 master->dev.parent = dev;
Linus Walleijd7e2ee22016-04-11 13:51:03 +02001812 pm_suspend_ignore_children(&master->dev, true);
David Brownell0c868462006-01-08 13:34:25 -08001813 spi_master_set_devdata(master, &master[1]);
David Brownell8ae12a02006-01-08 13:34:19 -08001814
1815 return master;
1816}
1817EXPORT_SYMBOL_GPL(spi_alloc_master);
1818
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001819#ifdef CONFIG_OF
1820static int of_spi_register_master(struct spi_master *master)
1821{
Grant Likelye80beb22013-02-12 17:48:37 +00001822 int nb, i, *cs;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001823 struct device_node *np = master->dev.of_node;
1824
1825 if (!np)
1826 return 0;
1827
1828 nb = of_gpio_named_count(np, "cs-gpios");
Jingoo Han5fe5f052013-10-14 10:31:51 +09001829 master->num_chipselect = max_t(int, nb, master->num_chipselect);
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001830
Andreas Larsson8ec5d842013-02-13 14:23:24 +01001831 /* Return error only for an incorrectly formed cs-gpios property */
1832 if (nb == 0 || nb == -ENOENT)
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001833 return 0;
Andreas Larsson8ec5d842013-02-13 14:23:24 +01001834 else if (nb < 0)
1835 return nb;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001836
1837 cs = devm_kzalloc(&master->dev,
1838 sizeof(int) * master->num_chipselect,
1839 GFP_KERNEL);
1840 master->cs_gpios = cs;
1841
1842 if (!master->cs_gpios)
1843 return -ENOMEM;
1844
Andreas Larsson0da83bb2013-01-29 15:53:40 +01001845 for (i = 0; i < master->num_chipselect; i++)
Andreas Larsson446411e2013-02-13 14:20:25 +01001846 cs[i] = -ENOENT;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001847
1848 for (i = 0; i < nb; i++)
1849 cs[i] = of_get_named_gpio(np, "cs-gpios", i);
1850
1851 return 0;
1852}
1853#else
1854static int of_spi_register_master(struct spi_master *master)
1855{
1856 return 0;
1857}
1858#endif
1859
David Brownell8ae12a02006-01-08 13:34:19 -08001860/**
1861 * spi_register_master - register SPI master controller
1862 * @master: initialized master, originally from spi_alloc_master()
David Brownell33e34dc2007-05-08 00:32:21 -07001863 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001864 *
1865 * SPI master controllers connect to their drivers using some non-SPI bus,
1866 * such as the platform bus. The final stage of probe() in that code
1867 * includes calling spi_register_master() to hook up to this SPI bus glue.
1868 *
1869 * SPI controllers use board specific (often SOC specific) bus numbers,
1870 * and board-specific addressing for SPI devices combines those numbers
1871 * with chip select numbers. Since SPI does not directly support dynamic
1872 * device identification, boards need configuration tables telling which
1873 * chip is at which address.
1874 *
1875 * This must be called from context that can sleep. It returns zero on
1876 * success, else a negative error code (dropping the master's refcount).
David Brownell0c868462006-01-08 13:34:25 -08001877 * After a successful return, the caller is responsible for calling
1878 * spi_unregister_master().
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001879 *
1880 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08001881 */
Adrian Bunke9d5a462007-03-26 21:32:23 -08001882int spi_register_master(struct spi_master *master)
David Brownell8ae12a02006-01-08 13:34:19 -08001883{
David Brownelle44a45a2007-06-03 13:50:40 -07001884 static atomic_t dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
Tony Jones49dce682007-10-16 01:27:48 -07001885 struct device *dev = master->dev.parent;
Feng Tang2b9603a2010-08-02 15:52:15 +08001886 struct boardinfo *bi;
David Brownell8ae12a02006-01-08 13:34:19 -08001887 int status = -ENODEV;
1888 int dynamic = 0;
1889
David Brownell0c868462006-01-08 13:34:25 -08001890 if (!dev)
1891 return -ENODEV;
1892
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001893 status = of_spi_register_master(master);
1894 if (status)
1895 return status;
1896
David Brownell082c8cb2007-07-31 00:39:45 -07001897 /* even if it's just one always-selected device, there must
1898 * be at least one chipselect
1899 */
1900 if (master->num_chipselect == 0)
1901 return -EINVAL;
1902
Grant Likelybb297852012-12-21 19:32:09 +00001903 if ((master->bus_num < 0) && master->dev.of_node)
1904 master->bus_num = of_alias_get_id(master->dev.of_node, "spi");
1905
David Brownell8ae12a02006-01-08 13:34:19 -08001906 /* convention: dynamically assigned bus IDs count down from the max */
David Brownella020ed72006-04-03 15:49:04 -07001907 if (master->bus_num < 0) {
David Brownell082c8cb2007-07-31 00:39:45 -07001908 /* FIXME switch to an IDR based scheme, something like
1909 * I2C now uses, so we can't run out of "dynamic" IDs
1910 */
David Brownell8ae12a02006-01-08 13:34:19 -08001911 master->bus_num = atomic_dec_return(&dyn_bus_id);
David Brownellb8852442006-01-08 13:34:23 -08001912 dynamic = 1;
David Brownell8ae12a02006-01-08 13:34:19 -08001913 }
1914
Mark Brown5424d432014-12-10 17:40:53 +00001915 INIT_LIST_HEAD(&master->queue);
1916 spin_lock_init(&master->queue_lock);
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001917 spin_lock_init(&master->bus_lock_spinlock);
1918 mutex_init(&master->bus_lock_mutex);
Mark Brownef4d96e2016-07-21 23:53:31 +01001919 mutex_init(&master->io_mutex);
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001920 master->bus_lock_flag = 0;
Mark Brownb1589352013-10-05 11:50:40 +01001921 init_completion(&master->xfer_completion);
Mark Brown6ad45a22014-02-02 13:47:47 +00001922 if (!master->max_dma_len)
1923 master->max_dma_len = INT_MAX;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001924
David Brownell8ae12a02006-01-08 13:34:19 -08001925 /* register the device, then userspace will see it.
1926 * registration fails if the bus ID is in use.
1927 */
Kay Sievers35f74fc2009-01-06 10:44:37 -08001928 dev_set_name(&master->dev, "spi%u", master->bus_num);
Tony Jones49dce682007-10-16 01:27:48 -07001929 status = device_add(&master->dev);
David Brownellb8852442006-01-08 13:34:23 -08001930 if (status < 0)
David Brownell8ae12a02006-01-08 13:34:19 -08001931 goto done;
Kay Sievers35f74fc2009-01-06 10:44:37 -08001932 dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
David Brownell8ae12a02006-01-08 13:34:19 -08001933 dynamic ? " (dynamic)" : "");
1934
Linus Walleijffbbdd212012-02-22 10:05:38 +01001935 /* If we're using a queued driver, start the queue */
1936 if (master->transfer)
1937 dev_info(dev, "master is unqueued, this is deprecated\n");
1938 else {
1939 status = spi_master_initialize_queue(master);
1940 if (status) {
Axel Line93b0722013-08-31 20:25:52 +08001941 device_del(&master->dev);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001942 goto done;
1943 }
1944 }
Martin Sperleca2ebc2015-06-22 13:00:36 +00001945 /* add statistics */
1946 spin_lock_init(&master->statistics.lock);
Linus Walleijffbbdd212012-02-22 10:05:38 +01001947
Feng Tang2b9603a2010-08-02 15:52:15 +08001948 mutex_lock(&board_lock);
1949 list_add_tail(&master->list, &spi_master_list);
1950 list_for_each_entry(bi, &board_list, list)
1951 spi_match_master_to_boardinfo(master, &bi->board_info);
1952 mutex_unlock(&board_lock);
1953
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001954 /* Register devices from the device tree and ACPI */
Anatolij Gustschin12b15e82010-07-27 22:35:58 +02001955 of_register_spi_devices(master);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001956 acpi_register_spi_devices(master);
David Brownell8ae12a02006-01-08 13:34:19 -08001957done:
1958 return status;
1959}
1960EXPORT_SYMBOL_GPL(spi_register_master);
1961
Mark Brown666d5b42013-08-31 18:50:52 +01001962static void devm_spi_unregister(struct device *dev, void *res)
1963{
1964 spi_unregister_master(*(struct spi_master **)res);
1965}
1966
1967/**
1968 * dev_spi_register_master - register managed SPI master controller
1969 * @dev: device managing SPI master
1970 * @master: initialized master, originally from spi_alloc_master()
1971 * Context: can sleep
1972 *
1973 * Register a SPI device as with spi_register_master() which will
1974 * automatically be unregister
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02001975 *
1976 * Return: zero on success, else a negative error code.
Mark Brown666d5b42013-08-31 18:50:52 +01001977 */
1978int devm_spi_register_master(struct device *dev, struct spi_master *master)
1979{
1980 struct spi_master **ptr;
1981 int ret;
1982
1983 ptr = devres_alloc(devm_spi_unregister, sizeof(*ptr), GFP_KERNEL);
1984 if (!ptr)
1985 return -ENOMEM;
1986
1987 ret = spi_register_master(master);
Stephen Warren4b928942013-11-21 16:11:15 -07001988 if (!ret) {
Mark Brown666d5b42013-08-31 18:50:52 +01001989 *ptr = master;
1990 devres_add(dev, ptr);
1991 } else {
1992 devres_free(ptr);
1993 }
1994
1995 return ret;
1996}
1997EXPORT_SYMBOL_GPL(devm_spi_register_master);
1998
David Lamparter34860082010-08-30 23:54:17 +02001999static int __unregister(struct device *dev, void *null)
David Brownell8ae12a02006-01-08 13:34:19 -08002000{
David Lamparter34860082010-08-30 23:54:17 +02002001 spi_unregister_device(to_spi_device(dev));
David Brownell8ae12a02006-01-08 13:34:19 -08002002 return 0;
2003}
2004
2005/**
2006 * spi_unregister_master - unregister SPI master controller
2007 * @master: the master being unregistered
David Brownell33e34dc2007-05-08 00:32:21 -07002008 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08002009 *
2010 * This call is used only by SPI master controller drivers, which are the
2011 * only ones directly touching chip registers.
2012 *
2013 * This must be called from context that can sleep.
2014 */
2015void spi_unregister_master(struct spi_master *master)
2016{
Jeff Garzik89fc9a12006-12-06 20:35:35 -08002017 int dummy;
2018
Linus Walleijffbbdd212012-02-22 10:05:38 +01002019 if (master->queued) {
2020 if (spi_destroy_queue(master))
2021 dev_err(&master->dev, "queue remove failed\n");
2022 }
2023
Feng Tang2b9603a2010-08-02 15:52:15 +08002024 mutex_lock(&board_lock);
2025 list_del(&master->list);
2026 mutex_unlock(&board_lock);
2027
Sebastian Andrzej Siewior97dbf372010-12-21 17:24:31 -08002028 dummy = device_for_each_child(&master->dev, NULL, __unregister);
Tony Jones49dce682007-10-16 01:27:48 -07002029 device_unregister(&master->dev);
David Brownell8ae12a02006-01-08 13:34:19 -08002030}
2031EXPORT_SYMBOL_GPL(spi_unregister_master);
2032
Linus Walleijffbbdd212012-02-22 10:05:38 +01002033int spi_master_suspend(struct spi_master *master)
2034{
2035 int ret;
2036
2037 /* Basically no-ops for non-queued masters */
2038 if (!master->queued)
2039 return 0;
2040
2041 ret = spi_stop_queue(master);
2042 if (ret)
2043 dev_err(&master->dev, "queue stop failed\n");
2044
2045 return ret;
2046}
2047EXPORT_SYMBOL_GPL(spi_master_suspend);
2048
2049int spi_master_resume(struct spi_master *master)
2050{
2051 int ret;
2052
2053 if (!master->queued)
2054 return 0;
2055
2056 ret = spi_start_queue(master);
2057 if (ret)
2058 dev_err(&master->dev, "queue restart failed\n");
2059
2060 return ret;
2061}
2062EXPORT_SYMBOL_GPL(spi_master_resume);
2063
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002064static int __spi_master_match(struct device *dev, const void *data)
Dave Young5ed2c832008-01-22 15:14:18 +08002065{
2066 struct spi_master *m;
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002067 const u16 *bus_num = data;
Dave Young5ed2c832008-01-22 15:14:18 +08002068
2069 m = container_of(dev, struct spi_master, dev);
2070 return m->bus_num == *bus_num;
2071}
2072
David Brownell8ae12a02006-01-08 13:34:19 -08002073/**
2074 * spi_busnum_to_master - look up master associated with bus_num
2075 * @bus_num: the master's bus number
David Brownell33e34dc2007-05-08 00:32:21 -07002076 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08002077 *
2078 * This call may be used with devices that are registered after
2079 * arch init time. It returns a refcounted pointer to the relevant
2080 * spi_master (which the caller must release), or NULL if there is
2081 * no such master registered.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002082 *
2083 * Return: the SPI master structure on success, else NULL.
David Brownell8ae12a02006-01-08 13:34:19 -08002084 */
2085struct spi_master *spi_busnum_to_master(u16 bus_num)
2086{
Tony Jones49dce682007-10-16 01:27:48 -07002087 struct device *dev;
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -08002088 struct spi_master *master = NULL;
David Brownell8ae12a02006-01-08 13:34:19 -08002089
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04002090 dev = class_find_device(&spi_master_class, NULL, &bus_num,
Dave Young5ed2c832008-01-22 15:14:18 +08002091 __spi_master_match);
2092 if (dev)
2093 master = container_of(dev, struct spi_master, dev);
2094 /* reference got in class_find_device */
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -08002095 return master;
David Brownell8ae12a02006-01-08 13:34:19 -08002096}
2097EXPORT_SYMBOL_GPL(spi_busnum_to_master);
2098
Martin Sperld780c372015-12-14 15:20:18 +00002099/*-------------------------------------------------------------------------*/
2100
2101/* Core methods for SPI resource management */
2102
2103/**
2104 * spi_res_alloc - allocate a spi resource that is life-cycle managed
2105 * during the processing of a spi_message while using
2106 * spi_transfer_one
2107 * @spi: the spi device for which we allocate memory
2108 * @release: the release code to execute for this resource
2109 * @size: size to alloc and return
2110 * @gfp: GFP allocation flags
2111 *
2112 * Return: the pointer to the allocated data
2113 *
2114 * This may get enhanced in the future to allocate from a memory pool
2115 * of the @spi_device or @spi_master to avoid repeated allocations.
2116 */
2117void *spi_res_alloc(struct spi_device *spi,
2118 spi_res_release_t release,
2119 size_t size, gfp_t gfp)
2120{
2121 struct spi_res *sres;
2122
2123 sres = kzalloc(sizeof(*sres) + size, gfp);
2124 if (!sres)
2125 return NULL;
2126
2127 INIT_LIST_HEAD(&sres->entry);
2128 sres->release = release;
2129
2130 return sres->data;
2131}
2132EXPORT_SYMBOL_GPL(spi_res_alloc);
2133
2134/**
2135 * spi_res_free - free an spi resource
2136 * @res: pointer to the custom data of a resource
2137 *
2138 */
2139void spi_res_free(void *res)
2140{
2141 struct spi_res *sres = container_of(res, struct spi_res, data);
2142
2143 if (!res)
2144 return;
2145
2146 WARN_ON(!list_empty(&sres->entry));
2147 kfree(sres);
2148}
2149EXPORT_SYMBOL_GPL(spi_res_free);
2150
2151/**
2152 * spi_res_add - add a spi_res to the spi_message
2153 * @message: the spi message
2154 * @res: the spi_resource
2155 */
2156void spi_res_add(struct spi_message *message, void *res)
2157{
2158 struct spi_res *sres = container_of(res, struct spi_res, data);
2159
2160 WARN_ON(!list_empty(&sres->entry));
2161 list_add_tail(&sres->entry, &message->resources);
2162}
2163EXPORT_SYMBOL_GPL(spi_res_add);
2164
2165/**
2166 * spi_res_release - release all spi resources for this message
2167 * @master: the @spi_master
2168 * @message: the @spi_message
2169 */
2170void spi_res_release(struct spi_master *master,
2171 struct spi_message *message)
2172{
2173 struct spi_res *res;
2174
2175 while (!list_empty(&message->resources)) {
2176 res = list_last_entry(&message->resources,
2177 struct spi_res, entry);
2178
2179 if (res->release)
2180 res->release(master, message, res->data);
2181
2182 list_del(&res->entry);
2183
2184 kfree(res);
2185 }
2186}
2187EXPORT_SYMBOL_GPL(spi_res_release);
David Brownell8ae12a02006-01-08 13:34:19 -08002188
2189/*-------------------------------------------------------------------------*/
2190
Martin Sperl523baf5a2015-12-14 15:20:19 +00002191/* Core methods for spi_message alterations */
2192
2193static void __spi_replace_transfers_release(struct spi_master *master,
2194 struct spi_message *msg,
2195 void *res)
2196{
2197 struct spi_replaced_transfers *rxfer = res;
2198 size_t i;
2199
2200 /* call extra callback if requested */
2201 if (rxfer->release)
2202 rxfer->release(master, msg, res);
2203
2204 /* insert replaced transfers back into the message */
2205 list_splice(&rxfer->replaced_transfers, rxfer->replaced_after);
2206
2207 /* remove the formerly inserted entries */
2208 for (i = 0; i < rxfer->inserted; i++)
2209 list_del(&rxfer->inserted_transfers[i].transfer_list);
2210}
2211
2212/**
2213 * spi_replace_transfers - replace transfers with several transfers
2214 * and register change with spi_message.resources
2215 * @msg: the spi_message we work upon
2216 * @xfer_first: the first spi_transfer we want to replace
2217 * @remove: number of transfers to remove
2218 * @insert: the number of transfers we want to insert instead
2219 * @release: extra release code necessary in some circumstances
2220 * @extradatasize: extra data to allocate (with alignment guarantees
2221 * of struct @spi_transfer)
Martin Sperl05885392016-02-18 15:53:11 +00002222 * @gfp: gfp flags
Martin Sperl523baf5a2015-12-14 15:20:19 +00002223 *
2224 * Returns: pointer to @spi_replaced_transfers,
2225 * PTR_ERR(...) in case of errors.
2226 */
2227struct spi_replaced_transfers *spi_replace_transfers(
2228 struct spi_message *msg,
2229 struct spi_transfer *xfer_first,
2230 size_t remove,
2231 size_t insert,
2232 spi_replaced_release_t release,
2233 size_t extradatasize,
2234 gfp_t gfp)
2235{
2236 struct spi_replaced_transfers *rxfer;
2237 struct spi_transfer *xfer;
2238 size_t i;
2239
2240 /* allocate the structure using spi_res */
2241 rxfer = spi_res_alloc(msg->spi, __spi_replace_transfers_release,
2242 insert * sizeof(struct spi_transfer)
2243 + sizeof(struct spi_replaced_transfers)
2244 + extradatasize,
2245 gfp);
2246 if (!rxfer)
2247 return ERR_PTR(-ENOMEM);
2248
2249 /* the release code to invoke before running the generic release */
2250 rxfer->release = release;
2251
2252 /* assign extradata */
2253 if (extradatasize)
2254 rxfer->extradata =
2255 &rxfer->inserted_transfers[insert];
2256
2257 /* init the replaced_transfers list */
2258 INIT_LIST_HEAD(&rxfer->replaced_transfers);
2259
2260 /* assign the list_entry after which we should reinsert
2261 * the @replaced_transfers - it may be spi_message.messages!
2262 */
2263 rxfer->replaced_after = xfer_first->transfer_list.prev;
2264
2265 /* remove the requested number of transfers */
2266 for (i = 0; i < remove; i++) {
2267 /* if the entry after replaced_after it is msg->transfers
2268 * then we have been requested to remove more transfers
2269 * than are in the list
2270 */
2271 if (rxfer->replaced_after->next == &msg->transfers) {
2272 dev_err(&msg->spi->dev,
2273 "requested to remove more spi_transfers than are available\n");
2274 /* insert replaced transfers back into the message */
2275 list_splice(&rxfer->replaced_transfers,
2276 rxfer->replaced_after);
2277
2278 /* free the spi_replace_transfer structure */
2279 spi_res_free(rxfer);
2280
2281 /* and return with an error */
2282 return ERR_PTR(-EINVAL);
2283 }
2284
2285 /* remove the entry after replaced_after from list of
2286 * transfers and add it to list of replaced_transfers
2287 */
2288 list_move_tail(rxfer->replaced_after->next,
2289 &rxfer->replaced_transfers);
2290 }
2291
2292 /* create copy of the given xfer with identical settings
2293 * based on the first transfer to get removed
2294 */
2295 for (i = 0; i < insert; i++) {
2296 /* we need to run in reverse order */
2297 xfer = &rxfer->inserted_transfers[insert - 1 - i];
2298
2299 /* copy all spi_transfer data */
2300 memcpy(xfer, xfer_first, sizeof(*xfer));
2301
2302 /* add to list */
2303 list_add(&xfer->transfer_list, rxfer->replaced_after);
2304
2305 /* clear cs_change and delay_usecs for all but the last */
2306 if (i) {
2307 xfer->cs_change = false;
2308 xfer->delay_usecs = 0;
2309 }
2310 }
2311
2312 /* set up inserted */
2313 rxfer->inserted = insert;
2314
2315 /* and register it with spi_res/spi_message */
2316 spi_res_add(msg, rxfer);
2317
2318 return rxfer;
2319}
2320EXPORT_SYMBOL_GPL(spi_replace_transfers);
2321
Fabio Estevam08933412016-02-14 13:33:50 -02002322static int __spi_split_transfer_maxsize(struct spi_master *master,
2323 struct spi_message *msg,
2324 struct spi_transfer **xferp,
2325 size_t maxsize,
2326 gfp_t gfp)
Martin Sperld9f12122015-12-14 15:20:20 +00002327{
2328 struct spi_transfer *xfer = *xferp, *xfers;
2329 struct spi_replaced_transfers *srt;
2330 size_t offset;
2331 size_t count, i;
2332
2333 /* warn once about this fact that we are splitting a transfer */
2334 dev_warn_once(&msg->spi->dev,
Fabio Estevam7d62f512016-02-17 15:42:27 -02002335 "spi_transfer of length %i exceed max length of %zu - needed to split transfers\n",
Martin Sperld9f12122015-12-14 15:20:20 +00002336 xfer->len, maxsize);
2337
2338 /* calculate how many we have to replace */
2339 count = DIV_ROUND_UP(xfer->len, maxsize);
2340
2341 /* create replacement */
2342 srt = spi_replace_transfers(msg, xfer, 1, count, NULL, 0, gfp);
Dan Carpenter657d32e2016-02-12 09:38:33 +03002343 if (IS_ERR(srt))
2344 return PTR_ERR(srt);
Martin Sperld9f12122015-12-14 15:20:20 +00002345 xfers = srt->inserted_transfers;
2346
2347 /* now handle each of those newly inserted spi_transfers
2348 * note that the replacements spi_transfers all are preset
2349 * to the same values as *xferp, so tx_buf, rx_buf and len
2350 * are all identical (as well as most others)
2351 * so we just have to fix up len and the pointers.
2352 *
2353 * this also includes support for the depreciated
2354 * spi_message.is_dma_mapped interface
2355 */
2356
2357 /* the first transfer just needs the length modified, so we
2358 * run it outside the loop
2359 */
Fabio Estevamc8dab772016-02-17 15:42:28 -02002360 xfers[0].len = min_t(size_t, maxsize, xfer[0].len);
Martin Sperld9f12122015-12-14 15:20:20 +00002361
2362 /* all the others need rx_buf/tx_buf also set */
2363 for (i = 1, offset = maxsize; i < count; offset += maxsize, i++) {
2364 /* update rx_buf, tx_buf and dma */
2365 if (xfers[i].rx_buf)
2366 xfers[i].rx_buf += offset;
2367 if (xfers[i].rx_dma)
2368 xfers[i].rx_dma += offset;
2369 if (xfers[i].tx_buf)
2370 xfers[i].tx_buf += offset;
2371 if (xfers[i].tx_dma)
2372 xfers[i].tx_dma += offset;
2373
2374 /* update length */
2375 xfers[i].len = min(maxsize, xfers[i].len - offset);
2376 }
2377
2378 /* we set up xferp to the last entry we have inserted,
2379 * so that we skip those already split transfers
2380 */
2381 *xferp = &xfers[count - 1];
2382
2383 /* increment statistics counters */
2384 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics,
2385 transfers_split_maxsize);
2386 SPI_STATISTICS_INCREMENT_FIELD(&msg->spi->statistics,
2387 transfers_split_maxsize);
2388
2389 return 0;
2390}
2391
2392/**
2393 * spi_split_tranfers_maxsize - split spi transfers into multiple transfers
2394 * when an individual transfer exceeds a
2395 * certain size
2396 * @master: the @spi_master for this transfer
Masanari Iida3700ce92016-02-22 20:33:44 +09002397 * @msg: the @spi_message to transform
2398 * @maxsize: the maximum when to apply this
Javier Martinez Canillas10f11a22016-03-10 15:01:14 -03002399 * @gfp: GFP allocation flags
Martin Sperld9f12122015-12-14 15:20:20 +00002400 *
2401 * Return: status of transformation
2402 */
2403int spi_split_transfers_maxsize(struct spi_master *master,
2404 struct spi_message *msg,
2405 size_t maxsize,
2406 gfp_t gfp)
2407{
2408 struct spi_transfer *xfer;
2409 int ret;
2410
2411 /* iterate over the transfer_list,
2412 * but note that xfer is advanced to the last transfer inserted
2413 * to avoid checking sizes again unnecessarily (also xfer does
2414 * potentiall belong to a different list by the time the
2415 * replacement has happened
2416 */
2417 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
2418 if (xfer->len > maxsize) {
2419 ret = __spi_split_transfer_maxsize(
2420 master, msg, &xfer, maxsize, gfp);
2421 if (ret)
2422 return ret;
2423 }
2424 }
2425
2426 return 0;
2427}
2428EXPORT_SYMBOL_GPL(spi_split_transfers_maxsize);
David Brownell8ae12a02006-01-08 13:34:19 -08002429
2430/*-------------------------------------------------------------------------*/
2431
David Brownell7d077192009-06-17 16:26:03 -07002432/* Core methods for SPI master protocol drivers. Some of the
2433 * other core methods are currently defined as inline functions.
2434 */
2435
Stefan Brüns63ab6452015-08-23 16:06:30 +02002436static int __spi_validate_bits_per_word(struct spi_master *master, u8 bits_per_word)
2437{
2438 if (master->bits_per_word_mask) {
2439 /* Only 32 bits fit in the mask */
2440 if (bits_per_word > 32)
2441 return -EINVAL;
2442 if (!(master->bits_per_word_mask &
2443 SPI_BPW_MASK(bits_per_word)))
2444 return -EINVAL;
2445 }
2446
2447 return 0;
2448}
2449
David Brownell7d077192009-06-17 16:26:03 -07002450/**
2451 * spi_setup - setup SPI mode and clock rate
2452 * @spi: the device whose settings are being modified
2453 * Context: can sleep, and no requests are queued to the device
2454 *
2455 * SPI protocol drivers may need to update the transfer mode if the
2456 * device doesn't work with its default. They may likewise need
2457 * to update clock rates or word sizes from initial values. This function
2458 * changes those settings, and must be called from a context that can sleep.
2459 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
2460 * effect the next time the device is selected and data is transferred to
2461 * or from it. When this function returns, the spi device is deselected.
2462 *
2463 * Note that this call will fail if the protocol driver specifies an option
2464 * that the underlying controller or its driver does not support. For
2465 * example, not all hardware supports wire transfers using nine bit words,
2466 * LSB-first wire encoding, or active-high chipselects.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002467 *
2468 * Return: zero on success, else a negative error code.
David Brownell7d077192009-06-17 16:26:03 -07002469 */
2470int spi_setup(struct spi_device *spi)
2471{
Geert Uytterhoeven83596fb2014-04-14 19:39:53 +02002472 unsigned bad_bits, ugly_bits;
Andy Shevchenko5ab8d262015-10-14 22:43:07 +03002473 int status;
David Brownell7d077192009-06-17 16:26:03 -07002474
wangyuhangf477b7f2013-08-11 18:15:17 +08002475 /* check mode to prevent that DUAL and QUAD set at the same time
2476 */
2477 if (((spi->mode & SPI_TX_DUAL) && (spi->mode & SPI_TX_QUAD)) ||
2478 ((spi->mode & SPI_RX_DUAL) && (spi->mode & SPI_RX_QUAD))) {
2479 dev_err(&spi->dev,
2480 "setup: can not select dual and quad at the same time\n");
2481 return -EINVAL;
2482 }
2483 /* if it is SPI_3WIRE mode, DUAL and QUAD should be forbidden
2484 */
2485 if ((spi->mode & SPI_3WIRE) && (spi->mode &
2486 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD)))
2487 return -EINVAL;
David Brownelle7db06b2009-06-17 16:26:04 -07002488 /* help drivers fail *cleanly* when they need options
2489 * that aren't supported with their current master
2490 */
2491 bad_bits = spi->mode & ~spi->master->mode_bits;
Geert Uytterhoeven83596fb2014-04-14 19:39:53 +02002492 ugly_bits = bad_bits &
2493 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD);
2494 if (ugly_bits) {
2495 dev_warn(&spi->dev,
2496 "setup: ignoring unsupported mode bits %x\n",
2497 ugly_bits);
2498 spi->mode &= ~ugly_bits;
2499 bad_bits &= ~ugly_bits;
2500 }
David Brownelle7db06b2009-06-17 16:26:04 -07002501 if (bad_bits) {
Linus Walleijeb288a12010-10-21 21:06:44 +02002502 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
David Brownelle7db06b2009-06-17 16:26:04 -07002503 bad_bits);
2504 return -EINVAL;
2505 }
2506
David Brownell7d077192009-06-17 16:26:03 -07002507 if (!spi->bits_per_word)
2508 spi->bits_per_word = 8;
2509
Andy Shevchenko5ab8d262015-10-14 22:43:07 +03002510 status = __spi_validate_bits_per_word(spi->master, spi->bits_per_word);
2511 if (status)
2512 return status;
Stefan Brüns63ab6452015-08-23 16:06:30 +02002513
Axel Lin052eb2d2014-02-10 00:08:05 +08002514 if (!spi->max_speed_hz)
2515 spi->max_speed_hz = spi->master->max_speed_hz;
2516
Laxman Dewangancaae0702012-11-09 14:35:22 +05302517 if (spi->master->setup)
2518 status = spi->master->setup(spi);
David Brownell7d077192009-06-17 16:26:03 -07002519
Franklin S Cooper Jrabeedb02015-10-16 10:29:03 -05002520 spi_set_cs(spi, false);
2521
Jingoo Han5fe5f052013-10-14 10:31:51 +09002522 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 -07002523 (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
2524 (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
2525 (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
2526 (spi->mode & SPI_3WIRE) ? "3wire, " : "",
2527 (spi->mode & SPI_LOOP) ? "loopback, " : "",
2528 spi->bits_per_word, spi->max_speed_hz,
2529 status);
2530
2531 return status;
2532}
2533EXPORT_SYMBOL_GPL(spi_setup);
2534
Mark Brown90808732013-11-13 23:44:15 +00002535static int __spi_validate(struct spi_device *spi, struct spi_message *message)
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002536{
2537 struct spi_master *master = spi->master;
Laxman Dewangane6811d12012-11-09 14:36:45 +05302538 struct spi_transfer *xfer;
Atsushi Nemoto6ea31292014-02-28 23:03:16 +09002539 int w_size;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002540
Mark Brown24a00132013-07-10 15:05:40 +01002541 if (list_empty(&message->transfers))
2542 return -EINVAL;
Mark Brown24a00132013-07-10 15:05:40 +01002543
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002544 /* Half-duplex links include original MicroWire, and ones with
2545 * only one data pin like SPI_3WIRE (switches direction) or where
2546 * either MOSI or MISO is missing. They can also be caused by
2547 * software limitations.
2548 */
2549 if ((master->flags & SPI_MASTER_HALF_DUPLEX)
2550 || (spi->mode & SPI_3WIRE)) {
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002551 unsigned flags = master->flags;
2552
2553 list_for_each_entry(xfer, &message->transfers, transfer_list) {
2554 if (xfer->rx_buf && xfer->tx_buf)
2555 return -EINVAL;
2556 if ((flags & SPI_MASTER_NO_TX) && xfer->tx_buf)
2557 return -EINVAL;
2558 if ((flags & SPI_MASTER_NO_RX) && xfer->rx_buf)
2559 return -EINVAL;
2560 }
2561 }
2562
Laxman Dewangane6811d12012-11-09 14:36:45 +05302563 /**
Laxman Dewangan059b8ff2013-01-05 00:17:14 +05302564 * Set transfer bits_per_word and max speed as spi device default if
2565 * it is not set for this transfer.
wangyuhangf477b7f2013-08-11 18:15:17 +08002566 * Set transfer tx_nbits and rx_nbits as single transfer default
2567 * (SPI_NBITS_SINGLE) if it is not set for this transfer.
Laxman Dewangane6811d12012-11-09 14:36:45 +05302568 */
Martin Sperl77e80582015-11-27 12:31:09 +00002569 message->frame_length = 0;
Laxman Dewangane6811d12012-11-09 14:36:45 +05302570 list_for_each_entry(xfer, &message->transfers, transfer_list) {
Sourav Poddar078726c2013-07-18 15:31:25 +05302571 message->frame_length += xfer->len;
Laxman Dewangane6811d12012-11-09 14:36:45 +05302572 if (!xfer->bits_per_word)
2573 xfer->bits_per_word = spi->bits_per_word;
Axel Lina6f87fa2014-03-17 10:08:12 +08002574
2575 if (!xfer->speed_hz)
Laxman Dewangan059b8ff2013-01-05 00:17:14 +05302576 xfer->speed_hz = spi->max_speed_hz;
Mark Brown7dc9fbc2015-08-20 11:52:18 -07002577 if (!xfer->speed_hz)
2578 xfer->speed_hz = master->max_speed_hz;
Axel Lina6f87fa2014-03-17 10:08:12 +08002579
2580 if (master->max_speed_hz &&
2581 xfer->speed_hz > master->max_speed_hz)
2582 xfer->speed_hz = master->max_speed_hz;
Gabor Juhos56ede942013-08-14 10:25:28 +02002583
Stefan Brüns63ab6452015-08-23 16:06:30 +02002584 if (__spi_validate_bits_per_word(master, xfer->bits_per_word))
2585 return -EINVAL;
Mark Browna2fd4f92013-07-10 14:57:26 +01002586
Ivan T. Ivanov4d94bd22014-02-20 12:02:08 +02002587 /*
2588 * SPI transfer length should be multiple of SPI word size
2589 * where SPI word size should be power-of-two multiple
2590 */
2591 if (xfer->bits_per_word <= 8)
2592 w_size = 1;
2593 else if (xfer->bits_per_word <= 16)
2594 w_size = 2;
2595 else
2596 w_size = 4;
2597
Ivan T. Ivanov4d94bd22014-02-20 12:02:08 +02002598 /* No partial transfers accepted */
Atsushi Nemoto6ea31292014-02-28 23:03:16 +09002599 if (xfer->len % w_size)
Ivan T. Ivanov4d94bd22014-02-20 12:02:08 +02002600 return -EINVAL;
2601
Mark Browna2fd4f92013-07-10 14:57:26 +01002602 if (xfer->speed_hz && master->min_speed_hz &&
2603 xfer->speed_hz < master->min_speed_hz)
2604 return -EINVAL;
wangyuhangf477b7f2013-08-11 18:15:17 +08002605
2606 if (xfer->tx_buf && !xfer->tx_nbits)
2607 xfer->tx_nbits = SPI_NBITS_SINGLE;
2608 if (xfer->rx_buf && !xfer->rx_nbits)
2609 xfer->rx_nbits = SPI_NBITS_SINGLE;
2610 /* check transfer tx/rx_nbits:
Geert Uytterhoeven1afd9982014-01-12 14:00:29 +01002611 * 1. check the value matches one of single, dual and quad
2612 * 2. check tx/rx_nbits match the mode in spi_device
wangyuhangf477b7f2013-08-11 18:15:17 +08002613 */
Sourav Poddardb90a442013-08-22 21:20:48 +05302614 if (xfer->tx_buf) {
2615 if (xfer->tx_nbits != SPI_NBITS_SINGLE &&
2616 xfer->tx_nbits != SPI_NBITS_DUAL &&
2617 xfer->tx_nbits != SPI_NBITS_QUAD)
2618 return -EINVAL;
2619 if ((xfer->tx_nbits == SPI_NBITS_DUAL) &&
2620 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
2621 return -EINVAL;
2622 if ((xfer->tx_nbits == SPI_NBITS_QUAD) &&
2623 !(spi->mode & SPI_TX_QUAD))
2624 return -EINVAL;
Sourav Poddardb90a442013-08-22 21:20:48 +05302625 }
wangyuhangf477b7f2013-08-11 18:15:17 +08002626 /* check transfer rx_nbits */
Sourav Poddardb90a442013-08-22 21:20:48 +05302627 if (xfer->rx_buf) {
2628 if (xfer->rx_nbits != SPI_NBITS_SINGLE &&
2629 xfer->rx_nbits != SPI_NBITS_DUAL &&
2630 xfer->rx_nbits != SPI_NBITS_QUAD)
2631 return -EINVAL;
2632 if ((xfer->rx_nbits == SPI_NBITS_DUAL) &&
2633 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
2634 return -EINVAL;
2635 if ((xfer->rx_nbits == SPI_NBITS_QUAD) &&
2636 !(spi->mode & SPI_RX_QUAD))
2637 return -EINVAL;
Sourav Poddardb90a442013-08-22 21:20:48 +05302638 }
Laxman Dewangane6811d12012-11-09 14:36:45 +05302639 }
2640
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002641 message->status = -EINPROGRESS;
Mark Brown90808732013-11-13 23:44:15 +00002642
2643 return 0;
2644}
2645
2646static int __spi_async(struct spi_device *spi, struct spi_message *message)
2647{
2648 struct spi_master *master = spi->master;
2649
2650 message->spi = spi;
2651
Martin Sperleca2ebc2015-06-22 13:00:36 +00002652 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics, spi_async);
2653 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_async);
2654
Mark Brown90808732013-11-13 23:44:15 +00002655 trace_spi_message_submit(message);
2656
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002657 return master->transfer(spi, message);
2658}
2659
David Brownell568d0692009-09-22 16:46:18 -07002660/**
2661 * spi_async - asynchronous SPI transfer
2662 * @spi: device with which data will be exchanged
2663 * @message: describes the data transfers, including completion callback
2664 * Context: any (irqs may be blocked, etc)
2665 *
2666 * This call may be used in_irq and other contexts which can't sleep,
2667 * as well as from task contexts which can sleep.
2668 *
2669 * The completion callback is invoked in a context which can't sleep.
2670 * Before that invocation, the value of message->status is undefined.
2671 * When the callback is issued, message->status holds either zero (to
2672 * indicate complete success) or a negative error code. After that
2673 * callback returns, the driver which issued the transfer request may
2674 * deallocate the associated memory; it's no longer in use by any SPI
2675 * core or controller driver code.
2676 *
2677 * Note that although all messages to a spi_device are handled in
2678 * FIFO order, messages may go to different devices in other orders.
2679 * Some device might be higher priority, or have various "hard" access
2680 * time requirements, for example.
2681 *
2682 * On detection of any fault during the transfer, processing of
2683 * the entire message is aborted, and the device is deselected.
2684 * Until returning from the associated message completion callback,
2685 * no other spi_message queued to that device will be processed.
2686 * (This rule applies equally to all the synchronous transfer calls,
2687 * which are wrappers around this core asynchronous primitive.)
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002688 *
2689 * Return: zero on success, else a negative error code.
David Brownell568d0692009-09-22 16:46:18 -07002690 */
2691int spi_async(struct spi_device *spi, struct spi_message *message)
2692{
2693 struct spi_master *master = spi->master;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002694 int ret;
2695 unsigned long flags;
David Brownell568d0692009-09-22 16:46:18 -07002696
Mark Brown90808732013-11-13 23:44:15 +00002697 ret = __spi_validate(spi, message);
2698 if (ret != 0)
2699 return ret;
2700
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002701 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
David Brownell568d0692009-09-22 16:46:18 -07002702
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002703 if (master->bus_lock_flag)
2704 ret = -EBUSY;
2705 else
2706 ret = __spi_async(spi, message);
David Brownell568d0692009-09-22 16:46:18 -07002707
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002708 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2709
2710 return ret;
David Brownell568d0692009-09-22 16:46:18 -07002711}
2712EXPORT_SYMBOL_GPL(spi_async);
2713
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002714/**
2715 * spi_async_locked - version of spi_async with exclusive bus usage
2716 * @spi: device with which data will be exchanged
2717 * @message: describes the data transfers, including completion callback
2718 * Context: any (irqs may be blocked, etc)
2719 *
2720 * This call may be used in_irq and other contexts which can't sleep,
2721 * as well as from task contexts which can sleep.
2722 *
2723 * The completion callback is invoked in a context which can't sleep.
2724 * Before that invocation, the value of message->status is undefined.
2725 * When the callback is issued, message->status holds either zero (to
2726 * indicate complete success) or a negative error code. After that
2727 * callback returns, the driver which issued the transfer request may
2728 * deallocate the associated memory; it's no longer in use by any SPI
2729 * core or controller driver code.
2730 *
2731 * Note that although all messages to a spi_device are handled in
2732 * FIFO order, messages may go to different devices in other orders.
2733 * Some device might be higher priority, or have various "hard" access
2734 * time requirements, for example.
2735 *
2736 * On detection of any fault during the transfer, processing of
2737 * the entire message is aborted, and the device is deselected.
2738 * Until returning from the associated message completion callback,
2739 * no other spi_message queued to that device will be processed.
2740 * (This rule applies equally to all the synchronous transfer calls,
2741 * which are wrappers around this core asynchronous primitive.)
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002742 *
2743 * Return: zero on success, else a negative error code.
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002744 */
2745int spi_async_locked(struct spi_device *spi, struct spi_message *message)
2746{
2747 struct spi_master *master = spi->master;
2748 int ret;
2749 unsigned long flags;
2750
Mark Brown90808732013-11-13 23:44:15 +00002751 ret = __spi_validate(spi, message);
2752 if (ret != 0)
2753 return ret;
2754
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002755 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2756
2757 ret = __spi_async(spi, message);
2758
2759 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2760
2761 return ret;
2762
2763}
2764EXPORT_SYMBOL_GPL(spi_async_locked);
2765
David Brownell7d077192009-06-17 16:26:03 -07002766
Vignesh R556351f2015-12-11 09:39:56 +05302767int spi_flash_read(struct spi_device *spi,
2768 struct spi_flash_read_message *msg)
2769
2770{
2771 struct spi_master *master = spi->master;
Vignesh Rf4502dd2016-06-08 12:18:31 +05302772 struct device *rx_dev = NULL;
Vignesh R556351f2015-12-11 09:39:56 +05302773 int ret;
2774
2775 if ((msg->opcode_nbits == SPI_NBITS_DUAL ||
2776 msg->addr_nbits == SPI_NBITS_DUAL) &&
2777 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
2778 return -EINVAL;
2779 if ((msg->opcode_nbits == SPI_NBITS_QUAD ||
2780 msg->addr_nbits == SPI_NBITS_QUAD) &&
2781 !(spi->mode & SPI_TX_QUAD))
2782 return -EINVAL;
2783 if (msg->data_nbits == SPI_NBITS_DUAL &&
2784 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
2785 return -EINVAL;
2786 if (msg->data_nbits == SPI_NBITS_QUAD &&
2787 !(spi->mode & SPI_RX_QUAD))
2788 return -EINVAL;
2789
2790 if (master->auto_runtime_pm) {
2791 ret = pm_runtime_get_sync(master->dev.parent);
2792 if (ret < 0) {
2793 dev_err(&master->dev, "Failed to power device: %d\n",
2794 ret);
2795 return ret;
2796 }
2797 }
Vignesh Rf4502dd2016-06-08 12:18:31 +05302798
Vignesh R556351f2015-12-11 09:39:56 +05302799 mutex_lock(&master->bus_lock_mutex);
Mark Brownef4d96e2016-07-21 23:53:31 +01002800 mutex_lock(&master->io_mutex);
Vignesh Rf4502dd2016-06-08 12:18:31 +05302801 if (master->dma_rx) {
2802 rx_dev = master->dma_rx->device->dev;
2803 ret = spi_map_buf(master, rx_dev, &msg->rx_sg,
2804 msg->buf, msg->len,
2805 DMA_FROM_DEVICE);
2806 if (!ret)
2807 msg->cur_msg_mapped = true;
2808 }
Vignesh R556351f2015-12-11 09:39:56 +05302809 ret = master->spi_flash_read(spi, msg);
Vignesh Rf4502dd2016-06-08 12:18:31 +05302810 if (msg->cur_msg_mapped)
2811 spi_unmap_buf(master, rx_dev, &msg->rx_sg,
2812 DMA_FROM_DEVICE);
Mark Brownef4d96e2016-07-21 23:53:31 +01002813 mutex_unlock(&master->io_mutex);
Vignesh R556351f2015-12-11 09:39:56 +05302814 mutex_unlock(&master->bus_lock_mutex);
Vignesh Rf4502dd2016-06-08 12:18:31 +05302815
Vignesh R556351f2015-12-11 09:39:56 +05302816 if (master->auto_runtime_pm)
2817 pm_runtime_put(master->dev.parent);
2818
2819 return ret;
2820}
2821EXPORT_SYMBOL_GPL(spi_flash_read);
2822
David Brownell7d077192009-06-17 16:26:03 -07002823/*-------------------------------------------------------------------------*/
2824
2825/* Utility methods for SPI master protocol drivers, layered on
2826 * top of the core. Some other utility methods are defined as
2827 * inline functions.
2828 */
2829
Andrew Morton5d870c82006-01-11 11:23:49 -08002830static void spi_complete(void *arg)
2831{
2832 complete(arg);
2833}
2834
Mark Brownef4d96e2016-07-21 23:53:31 +01002835static int __spi_sync(struct spi_device *spi, struct spi_message *message)
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002836{
2837 DECLARE_COMPLETION_ONSTACK(done);
2838 int status;
2839 struct spi_master *master = spi->master;
Mark Brown0461a412014-12-09 21:38:05 +00002840 unsigned long flags;
2841
2842 status = __spi_validate(spi, message);
2843 if (status != 0)
2844 return status;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002845
2846 message->complete = spi_complete;
2847 message->context = &done;
Mark Brown0461a412014-12-09 21:38:05 +00002848 message->spi = spi;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002849
Martin Sperleca2ebc2015-06-22 13:00:36 +00002850 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics, spi_sync);
2851 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_sync);
2852
Mark Brown0461a412014-12-09 21:38:05 +00002853 /* If we're not using the legacy transfer method then we will
2854 * try to transfer in the calling context so special case.
2855 * This code would be less tricky if we could remove the
2856 * support for driver implemented message queues.
2857 */
2858 if (master->transfer == spi_queued_transfer) {
2859 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2860
2861 trace_spi_message_submit(message);
2862
2863 status = __spi_queued_transfer(spi, message, false);
2864
2865 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2866 } else {
2867 status = spi_async_locked(spi, message);
2868 }
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002869
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002870 if (status == 0) {
Mark Brown0461a412014-12-09 21:38:05 +00002871 /* Push out the messages in the calling context if we
2872 * can.
2873 */
Martin Sperleca2ebc2015-06-22 13:00:36 +00002874 if (master->transfer == spi_queued_transfer) {
2875 SPI_STATISTICS_INCREMENT_FIELD(&master->statistics,
2876 spi_sync_immediate);
2877 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics,
2878 spi_sync_immediate);
Mark Brownef4d96e2016-07-21 23:53:31 +01002879 __spi_pump_messages(master, false);
Martin Sperleca2ebc2015-06-22 13:00:36 +00002880 }
Mark Brown0461a412014-12-09 21:38:05 +00002881
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002882 wait_for_completion(&done);
2883 status = message->status;
2884 }
2885 message->context = NULL;
2886 return status;
2887}
2888
David Brownell8ae12a02006-01-08 13:34:19 -08002889/**
2890 * spi_sync - blocking/synchronous SPI data transfers
2891 * @spi: device with which data will be exchanged
2892 * @message: describes the data transfers
David Brownell33e34dc2007-05-08 00:32:21 -07002893 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08002894 *
2895 * This call may only be used from a context that may sleep. The sleep
2896 * is non-interruptible, and has no timeout. Low-overhead controller
2897 * drivers may DMA directly into and out of the message buffers.
2898 *
2899 * Note that the SPI device's chip select is active during the message,
2900 * and then is normally disabled between messages. Drivers for some
2901 * frequently-used devices may want to minimize costs of selecting a chip,
2902 * by leaving it selected in anticipation that the next message will go
2903 * to the same chip. (That may increase power usage.)
2904 *
David Brownell0c868462006-01-08 13:34:25 -08002905 * Also, the caller is guaranteeing that the memory associated with the
2906 * message will not be freed before this call returns.
2907 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002908 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08002909 */
2910int spi_sync(struct spi_device *spi, struct spi_message *message)
2911{
Mark Brownef4d96e2016-07-21 23:53:31 +01002912 int ret;
2913
2914 mutex_lock(&spi->master->bus_lock_mutex);
2915 ret = __spi_sync(spi, message);
2916 mutex_unlock(&spi->master->bus_lock_mutex);
2917
2918 return ret;
David Brownell8ae12a02006-01-08 13:34:19 -08002919}
2920EXPORT_SYMBOL_GPL(spi_sync);
2921
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002922/**
2923 * spi_sync_locked - version of spi_sync with exclusive bus usage
2924 * @spi: device with which data will be exchanged
2925 * @message: describes the data transfers
2926 * Context: can sleep
2927 *
2928 * This call may only be used from a context that may sleep. The sleep
2929 * is non-interruptible, and has no timeout. Low-overhead controller
2930 * drivers may DMA directly into and out of the message buffers.
2931 *
2932 * This call should be used by drivers that require exclusive access to the
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002933 * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002934 * be released by a spi_bus_unlock call when the exclusive access is over.
2935 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002936 * Return: zero on success, else a negative error code.
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002937 */
2938int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
2939{
Mark Brownef4d96e2016-07-21 23:53:31 +01002940 return __spi_sync(spi, message);
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002941}
2942EXPORT_SYMBOL_GPL(spi_sync_locked);
2943
2944/**
2945 * spi_bus_lock - obtain a lock for exclusive SPI bus usage
2946 * @master: SPI bus master that should be locked for exclusive bus access
2947 * Context: can sleep
2948 *
2949 * This call may only be used from a context that may sleep. The sleep
2950 * is non-interruptible, and has no timeout.
2951 *
2952 * This call should be used by drivers that require exclusive access to the
2953 * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
2954 * exclusive access is over. Data transfer must be done by spi_sync_locked
2955 * and spi_async_locked calls when the SPI bus lock is held.
2956 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002957 * Return: always zero.
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002958 */
2959int spi_bus_lock(struct spi_master *master)
2960{
2961 unsigned long flags;
2962
2963 mutex_lock(&master->bus_lock_mutex);
2964
2965 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2966 master->bus_lock_flag = 1;
2967 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2968
2969 /* mutex remains locked until spi_bus_unlock is called */
2970
2971 return 0;
2972}
2973EXPORT_SYMBOL_GPL(spi_bus_lock);
2974
2975/**
2976 * spi_bus_unlock - release the lock for exclusive SPI bus usage
2977 * @master: SPI bus master that was locked for exclusive bus access
2978 * Context: can sleep
2979 *
2980 * This call may only be used from a context that may sleep. The sleep
2981 * is non-interruptible, and has no timeout.
2982 *
2983 * This call releases an SPI bus lock previously obtained by an spi_bus_lock
2984 * call.
2985 *
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02002986 * Return: always zero.
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07002987 */
2988int spi_bus_unlock(struct spi_master *master)
2989{
2990 master->bus_lock_flag = 0;
2991
2992 mutex_unlock(&master->bus_lock_mutex);
2993
2994 return 0;
2995}
2996EXPORT_SYMBOL_GPL(spi_bus_unlock);
2997
David Brownella9948b62006-04-02 10:37:40 -08002998/* portable code must never pass more than 32 bytes */
Jingoo Han5fe5f052013-10-14 10:31:51 +09002999#define SPI_BUFSIZ max(32, SMP_CACHE_BYTES)
David Brownell8ae12a02006-01-08 13:34:19 -08003000
3001static u8 *buf;
3002
3003/**
3004 * spi_write_then_read - SPI synchronous write followed by read
3005 * @spi: device with which data will be exchanged
3006 * @txbuf: data to be written (need not be dma-safe)
3007 * @n_tx: size of txbuf, in bytes
Jiri Pirko27570492009-06-17 16:26:06 -07003008 * @rxbuf: buffer into which data will be read (need not be dma-safe)
3009 * @n_rx: size of rxbuf, in bytes
David Brownell33e34dc2007-05-08 00:32:21 -07003010 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08003011 *
3012 * This performs a half duplex MicroWire style transaction with the
3013 * device, sending txbuf and then reading rxbuf. The return value
3014 * is zero for success, else a negative errno status code.
David Brownellb8852442006-01-08 13:34:23 -08003015 * This call may only be used from a context that may sleep.
David Brownell8ae12a02006-01-08 13:34:19 -08003016 *
David Brownell0c868462006-01-08 13:34:25 -08003017 * Parameters to this routine are always copied using a small buffer;
David Brownell33e34dc2007-05-08 00:32:21 -07003018 * portable code should never use this for more than 32 bytes.
3019 * Performance-sensitive or bulk transfer code should instead use
David Brownell0c868462006-01-08 13:34:25 -08003020 * spi_{async,sync}() calls with dma-safe buffers.
Javier Martinez Canillas97d56dc2015-10-22 18:59:23 +02003021 *
3022 * Return: zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08003023 */
3024int spi_write_then_read(struct spi_device *spi,
Mark Brown0c4a1592011-05-11 00:09:30 +02003025 const void *txbuf, unsigned n_tx,
3026 void *rxbuf, unsigned n_rx)
David Brownell8ae12a02006-01-08 13:34:19 -08003027{
David Brownell068f4072007-12-04 23:45:09 -08003028 static DEFINE_MUTEX(lock);
David Brownell8ae12a02006-01-08 13:34:19 -08003029
3030 int status;
3031 struct spi_message message;
David Brownellbdff5492009-04-13 14:39:57 -07003032 struct spi_transfer x[2];
David Brownell8ae12a02006-01-08 13:34:19 -08003033 u8 *local_buf;
3034
Mark Brownb3a223e2012-12-02 12:54:25 +09003035 /* Use preallocated DMA-safe buffer if we can. We can't avoid
3036 * copying here, (as a pure convenience thing), but we can
3037 * keep heap costs out of the hot path unless someone else is
3038 * using the pre-allocated buffer or the transfer is too large.
David Brownell8ae12a02006-01-08 13:34:19 -08003039 */
Mark Brownb3a223e2012-12-02 12:54:25 +09003040 if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
Mark Brown2cd94c82013-01-27 14:35:04 +08003041 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
3042 GFP_KERNEL | GFP_DMA);
Mark Brownb3a223e2012-12-02 12:54:25 +09003043 if (!local_buf)
3044 return -ENOMEM;
3045 } else {
3046 local_buf = buf;
3047 }
David Brownell8ae12a02006-01-08 13:34:19 -08003048
Vitaly Wool8275c642006-01-08 13:34:28 -08003049 spi_message_init(&message);
Jingoo Han5fe5f052013-10-14 10:31:51 +09003050 memset(x, 0, sizeof(x));
David Brownellbdff5492009-04-13 14:39:57 -07003051 if (n_tx) {
3052 x[0].len = n_tx;
3053 spi_message_add_tail(&x[0], &message);
3054 }
3055 if (n_rx) {
3056 x[1].len = n_rx;
3057 spi_message_add_tail(&x[1], &message);
3058 }
Vitaly Wool8275c642006-01-08 13:34:28 -08003059
David Brownell8ae12a02006-01-08 13:34:19 -08003060 memcpy(local_buf, txbuf, n_tx);
David Brownellbdff5492009-04-13 14:39:57 -07003061 x[0].tx_buf = local_buf;
3062 x[1].rx_buf = local_buf + n_tx;
David Brownell8ae12a02006-01-08 13:34:19 -08003063
3064 /* do the i/o */
David Brownell8ae12a02006-01-08 13:34:19 -08003065 status = spi_sync(spi, &message);
Marc Pignat9b938b72007-12-04 23:45:10 -08003066 if (status == 0)
David Brownellbdff5492009-04-13 14:39:57 -07003067 memcpy(rxbuf, x[1].rx_buf, n_rx);
David Brownell8ae12a02006-01-08 13:34:19 -08003068
David Brownellbdff5492009-04-13 14:39:57 -07003069 if (x[0].tx_buf == buf)
David Brownell068f4072007-12-04 23:45:09 -08003070 mutex_unlock(&lock);
David Brownell8ae12a02006-01-08 13:34:19 -08003071 else
3072 kfree(local_buf);
3073
3074 return status;
3075}
3076EXPORT_SYMBOL_GPL(spi_write_then_read);
3077
3078/*-------------------------------------------------------------------------*/
3079
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003080#if IS_ENABLED(CONFIG_OF_DYNAMIC)
3081static int __spi_of_device_match(struct device *dev, void *data)
3082{
3083 return dev->of_node == data;
3084}
3085
3086/* must call put_device() when done with returned spi_device device */
3087static struct spi_device *of_find_spi_device_by_node(struct device_node *node)
3088{
3089 struct device *dev = bus_find_device(&spi_bus_type, NULL, node,
3090 __spi_of_device_match);
3091 return dev ? to_spi_device(dev) : NULL;
3092}
3093
3094static int __spi_of_master_match(struct device *dev, const void *data)
3095{
3096 return dev->of_node == data;
3097}
3098
3099/* the spi masters are not using spi_bus, so we find it with another way */
3100static struct spi_master *of_find_spi_master_by_node(struct device_node *node)
3101{
3102 struct device *dev;
3103
3104 dev = class_find_device(&spi_master_class, NULL, node,
3105 __spi_of_master_match);
3106 if (!dev)
3107 return NULL;
3108
3109 /* reference got in class_find_device */
3110 return container_of(dev, struct spi_master, dev);
3111}
3112
3113static int of_spi_notify(struct notifier_block *nb, unsigned long action,
3114 void *arg)
3115{
3116 struct of_reconfig_data *rd = arg;
3117 struct spi_master *master;
3118 struct spi_device *spi;
3119
3120 switch (of_reconfig_get_state_change(action, arg)) {
3121 case OF_RECONFIG_CHANGE_ADD:
3122 master = of_find_spi_master_by_node(rd->dn->parent);
3123 if (master == NULL)
3124 return NOTIFY_OK; /* not for us */
3125
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +01003126 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED)) {
3127 put_device(&master->dev);
3128 return NOTIFY_OK;
3129 }
3130
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003131 spi = of_register_spi_device(master, rd->dn);
3132 put_device(&master->dev);
3133
3134 if (IS_ERR(spi)) {
3135 pr_err("%s: failed to create for '%s'\n",
3136 __func__, rd->dn->full_name);
3137 return notifier_from_errno(PTR_ERR(spi));
3138 }
3139 break;
3140
3141 case OF_RECONFIG_CHANGE_REMOVE:
Geert Uytterhoevenbd6c1642015-11-30 15:28:07 +01003142 /* already depopulated? */
3143 if (!of_node_check_flag(rd->dn, OF_POPULATED))
3144 return NOTIFY_OK;
3145
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003146 /* find our device by node */
3147 spi = of_find_spi_device_by_node(rd->dn);
3148 if (spi == NULL)
3149 return NOTIFY_OK; /* no? not meant for us */
3150
3151 /* unregister takes one ref away */
3152 spi_unregister_device(spi);
3153
3154 /* and put the reference of the find */
3155 put_device(&spi->dev);
3156 break;
3157 }
3158
3159 return NOTIFY_OK;
3160}
3161
3162static struct notifier_block spi_of_notifier = {
3163 .notifier_call = of_spi_notify,
3164};
3165#else /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
3166extern struct notifier_block spi_of_notifier;
3167#endif /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
3168
Octavian Purdila7f244672016-07-08 19:13:11 +03003169#if IS_ENABLED(CONFIG_ACPI)
3170static int spi_acpi_master_match(struct device *dev, const void *data)
3171{
3172 return ACPI_COMPANION(dev->parent) == data;
3173}
3174
3175static int spi_acpi_device_match(struct device *dev, void *data)
3176{
3177 return ACPI_COMPANION(dev) == data;
3178}
3179
3180static struct spi_master *acpi_spi_find_master_by_adev(struct acpi_device *adev)
3181{
3182 struct device *dev;
3183
3184 dev = class_find_device(&spi_master_class, NULL, adev,
3185 spi_acpi_master_match);
3186 if (!dev)
3187 return NULL;
3188
3189 return container_of(dev, struct spi_master, dev);
3190}
3191
3192static struct spi_device *acpi_spi_find_device_by_adev(struct acpi_device *adev)
3193{
3194 struct device *dev;
3195
3196 dev = bus_find_device(&spi_bus_type, NULL, adev, spi_acpi_device_match);
3197
3198 return dev ? to_spi_device(dev) : NULL;
3199}
3200
3201static int acpi_spi_notify(struct notifier_block *nb, unsigned long value,
3202 void *arg)
3203{
3204 struct acpi_device *adev = arg;
3205 struct spi_master *master;
3206 struct spi_device *spi;
3207
3208 switch (value) {
3209 case ACPI_RECONFIG_DEVICE_ADD:
3210 master = acpi_spi_find_master_by_adev(adev->parent);
3211 if (!master)
3212 break;
3213
3214 acpi_register_spi_device(master, adev);
3215 put_device(&master->dev);
3216 break;
3217 case ACPI_RECONFIG_DEVICE_REMOVE:
3218 if (!acpi_device_enumerated(adev))
3219 break;
3220
3221 spi = acpi_spi_find_device_by_adev(adev);
3222 if (!spi)
3223 break;
3224
3225 spi_unregister_device(spi);
3226 put_device(&spi->dev);
3227 break;
3228 }
3229
3230 return NOTIFY_OK;
3231}
3232
3233static struct notifier_block spi_acpi_notifier = {
3234 .notifier_call = acpi_spi_notify,
3235};
3236#else
3237extern struct notifier_block spi_acpi_notifier;
3238#endif
3239
David Brownell8ae12a02006-01-08 13:34:19 -08003240static int __init spi_init(void)
3241{
David Brownellb8852442006-01-08 13:34:23 -08003242 int status;
David Brownell8ae12a02006-01-08 13:34:19 -08003243
Christoph Lametere94b1762006-12-06 20:33:17 -08003244 buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
David Brownellb8852442006-01-08 13:34:23 -08003245 if (!buf) {
3246 status = -ENOMEM;
3247 goto err0;
3248 }
3249
3250 status = bus_register(&spi_bus_type);
3251 if (status < 0)
3252 goto err1;
3253
3254 status = class_register(&spi_master_class);
3255 if (status < 0)
3256 goto err2;
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003257
Fabio Estevam52677202014-11-26 20:13:57 -02003258 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003259 WARN_ON(of_reconfig_notifier_register(&spi_of_notifier));
Octavian Purdila7f244672016-07-08 19:13:11 +03003260 if (IS_ENABLED(CONFIG_ACPI))
3261 WARN_ON(acpi_reconfig_notifier_register(&spi_acpi_notifier));
Pantelis Antoniouce79d542014-10-28 22:36:05 +02003262
David Brownell8ae12a02006-01-08 13:34:19 -08003263 return 0;
David Brownellb8852442006-01-08 13:34:23 -08003264
3265err2:
3266 bus_unregister(&spi_bus_type);
3267err1:
3268 kfree(buf);
3269 buf = NULL;
3270err0:
3271 return status;
David Brownell8ae12a02006-01-08 13:34:19 -08003272}
David Brownellb8852442006-01-08 13:34:23 -08003273
David Brownell8ae12a02006-01-08 13:34:19 -08003274/* board_info is normally registered in arch_initcall(),
3275 * but even essential drivers wait till later
David Brownellb8852442006-01-08 13:34:23 -08003276 *
3277 * REVISIT only boardinfo really needs static linking. the rest (device and
3278 * driver registration) _could_ be dynamically linked (modular) ... costs
3279 * include needing to have boardinfo data structures be much more public.
David Brownell8ae12a02006-01-08 13:34:19 -08003280 */
David Brownell673c0c02008-10-15 22:02:46 -07003281postcore_initcall(spi_init);
David Brownell8ae12a02006-01-08 13:34:19 -08003282