blob: ca99ac9295cffb6175c8f0091ad80cb566dbdf50 [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.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
David Brownell8ae12a02006-01-08 13:34:19 -080022#include <linux/kernel.h>
Grant Likelyd57a4282012-04-07 14:16:53 -060023#include <linux/kmod.h>
David Brownell8ae12a02006-01-08 13:34:19 -080024#include <linux/device.h>
25#include <linux/init.h>
26#include <linux/cache.h>
Matthias Kaehlcke94040822007-07-17 04:04:16 -070027#include <linux/mutex.h>
Sinan Akman2b7a32f2010-10-02 21:28:29 -060028#include <linux/of_device.h>
Grant Likelyd57a4282012-04-07 14:16:53 -060029#include <linux/of_irq.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090030#include <linux/slab.h>
Anton Vorontsove0626e32009-09-22 16:46:08 -070031#include <linux/mod_devicetable.h>
David Brownell8ae12a02006-01-08 13:34:19 -080032#include <linux/spi/spi.h>
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +010033#include <linux/of_gpio.h>
Mark Brown3ae22e82010-12-25 15:32:27 +010034#include <linux/pm_runtime.h>
Paul Gortmaker025ed132011-07-10 12:57:55 -040035#include <linux/export.h>
Clark Williams8bd75c72013-02-07 09:47:07 -060036#include <linux/sched/rt.h>
Linus Walleijffbbdd212012-02-22 10:05:38 +010037#include <linux/delay.h>
38#include <linux/kthread.h>
Mika Westerberg64bee4d2012-11-30 12:37:53 +010039#include <linux/ioport.h>
40#include <linux/acpi.h>
David Brownell8ae12a02006-01-08 13:34:19 -080041
David Brownell8ae12a02006-01-08 13:34:19 -080042static void spidev_release(struct device *dev)
43{
Hans-Peter Nilsson0ffa0282007-02-12 00:52:45 -080044 struct spi_device *spi = to_spi_device(dev);
David Brownell8ae12a02006-01-08 13:34:19 -080045
46 /* spi masters may cleanup for released devices */
47 if (spi->master->cleanup)
48 spi->master->cleanup(spi);
49
David Brownell0c868462006-01-08 13:34:25 -080050 spi_master_put(spi->master);
Roman Tereshonkov07a389f2010-04-12 09:56:35 +000051 kfree(spi);
David Brownell8ae12a02006-01-08 13:34:19 -080052}
53
54static ssize_t
55modalias_show(struct device *dev, struct device_attribute *a, char *buf)
56{
57 const struct spi_device *spi = to_spi_device(dev);
58
Grant Likelyd8e328b2012-05-20 00:08:13 -060059 return sprintf(buf, "%s%s\n", SPI_MODULE_PREFIX, spi->modalias);
David Brownell8ae12a02006-01-08 13:34:19 -080060}
61
62static struct device_attribute spi_dev_attrs[] = {
63 __ATTR_RO(modalias),
64 __ATTR_NULL,
65};
66
67/* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
68 * and the sysfs version makes coldplug work too.
69 */
70
Anton Vorontsov75368bf2009-09-22 16:46:04 -070071static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
72 const struct spi_device *sdev)
73{
74 while (id->name[0]) {
75 if (!strcmp(sdev->modalias, id->name))
76 return id;
77 id++;
78 }
79 return NULL;
80}
81
82const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
83{
84 const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
85
86 return spi_match_id(sdrv->id_table, sdev);
87}
88EXPORT_SYMBOL_GPL(spi_get_device_id);
89
David Brownell8ae12a02006-01-08 13:34:19 -080090static int spi_match_device(struct device *dev, struct device_driver *drv)
91{
92 const struct spi_device *spi = to_spi_device(dev);
Anton Vorontsov75368bf2009-09-22 16:46:04 -070093 const struct spi_driver *sdrv = to_spi_driver(drv);
94
Sinan Akman2b7a32f2010-10-02 21:28:29 -060095 /* Attempt an OF style match */
96 if (of_driver_match_device(dev, drv))
97 return 1;
98
Mika Westerberg64bee4d2012-11-30 12:37:53 +010099 /* Then try ACPI */
100 if (acpi_driver_match_device(dev, drv))
101 return 1;
102
Anton Vorontsov75368bf2009-09-22 16:46:04 -0700103 if (sdrv->id_table)
104 return !!spi_match_id(sdrv->id_table, spi);
David Brownell8ae12a02006-01-08 13:34:19 -0800105
Kay Sievers35f74fc2009-01-06 10:44:37 -0800106 return strcmp(spi->modalias, drv->name) == 0;
David Brownell8ae12a02006-01-08 13:34:19 -0800107}
108
Kay Sievers7eff2e72007-08-14 15:15:12 +0200109static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell8ae12a02006-01-08 13:34:19 -0800110{
111 const struct spi_device *spi = to_spi_device(dev);
112
Anton Vorontsove0626e32009-09-22 16:46:08 -0700113 add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
David Brownell8ae12a02006-01-08 13:34:19 -0800114 return 0;
115}
116
Mark Brown3ae22e82010-12-25 15:32:27 +0100117#ifdef CONFIG_PM_SLEEP
118static int spi_legacy_suspend(struct device *dev, pm_message_t message)
David Brownell8ae12a02006-01-08 13:34:19 -0800119{
David Brownell3c724262008-02-06 01:38:10 -0800120 int value = 0;
David Brownellb8852442006-01-08 13:34:23 -0800121 struct spi_driver *drv = to_spi_driver(dev->driver);
David Brownell8ae12a02006-01-08 13:34:19 -0800122
David Brownell8ae12a02006-01-08 13:34:19 -0800123 /* suspend will stop irqs and dma; no more i/o */
David Brownell3c724262008-02-06 01:38:10 -0800124 if (drv) {
125 if (drv->suspend)
126 value = drv->suspend(to_spi_device(dev), message);
127 else
128 dev_dbg(dev, "... can't suspend\n");
129 }
David Brownell8ae12a02006-01-08 13:34:19 -0800130 return value;
131}
132
Mark Brown3ae22e82010-12-25 15:32:27 +0100133static int spi_legacy_resume(struct device *dev)
David Brownell8ae12a02006-01-08 13:34:19 -0800134{
David Brownell3c724262008-02-06 01:38:10 -0800135 int value = 0;
David Brownellb8852442006-01-08 13:34:23 -0800136 struct spi_driver *drv = to_spi_driver(dev->driver);
David Brownell8ae12a02006-01-08 13:34:19 -0800137
David Brownell8ae12a02006-01-08 13:34:19 -0800138 /* resume may restart the i/o queue */
David Brownell3c724262008-02-06 01:38:10 -0800139 if (drv) {
140 if (drv->resume)
141 value = drv->resume(to_spi_device(dev));
142 else
143 dev_dbg(dev, "... can't resume\n");
144 }
David Brownell8ae12a02006-01-08 13:34:19 -0800145 return value;
146}
147
Mark Brown3ae22e82010-12-25 15:32:27 +0100148static int spi_pm_suspend(struct device *dev)
149{
150 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
151
152 if (pm)
153 return pm_generic_suspend(dev);
154 else
155 return spi_legacy_suspend(dev, PMSG_SUSPEND);
156}
157
158static int spi_pm_resume(struct device *dev)
159{
160 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
161
162 if (pm)
163 return pm_generic_resume(dev);
164 else
165 return spi_legacy_resume(dev);
166}
167
168static int spi_pm_freeze(struct device *dev)
169{
170 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
171
172 if (pm)
173 return pm_generic_freeze(dev);
174 else
175 return spi_legacy_suspend(dev, PMSG_FREEZE);
176}
177
178static int spi_pm_thaw(struct device *dev)
179{
180 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
181
182 if (pm)
183 return pm_generic_thaw(dev);
184 else
185 return spi_legacy_resume(dev);
186}
187
188static int spi_pm_poweroff(struct device *dev)
189{
190 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
191
192 if (pm)
193 return pm_generic_poweroff(dev);
194 else
195 return spi_legacy_suspend(dev, PMSG_HIBERNATE);
196}
197
198static int spi_pm_restore(struct device *dev)
199{
200 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
201
202 if (pm)
203 return pm_generic_restore(dev);
204 else
205 return spi_legacy_resume(dev);
206}
David Brownell8ae12a02006-01-08 13:34:19 -0800207#else
Mark Brown3ae22e82010-12-25 15:32:27 +0100208#define spi_pm_suspend NULL
209#define spi_pm_resume NULL
210#define spi_pm_freeze NULL
211#define spi_pm_thaw NULL
212#define spi_pm_poweroff NULL
213#define spi_pm_restore NULL
David Brownell8ae12a02006-01-08 13:34:19 -0800214#endif
215
Mark Brown3ae22e82010-12-25 15:32:27 +0100216static const struct dev_pm_ops spi_pm = {
217 .suspend = spi_pm_suspend,
218 .resume = spi_pm_resume,
219 .freeze = spi_pm_freeze,
220 .thaw = spi_pm_thaw,
221 .poweroff = spi_pm_poweroff,
222 .restore = spi_pm_restore,
223 SET_RUNTIME_PM_OPS(
224 pm_generic_runtime_suspend,
225 pm_generic_runtime_resume,
226 pm_generic_runtime_idle
227 )
228};
229
David Brownell8ae12a02006-01-08 13:34:19 -0800230struct bus_type spi_bus_type = {
231 .name = "spi",
232 .dev_attrs = spi_dev_attrs,
233 .match = spi_match_device,
234 .uevent = spi_uevent,
Mark Brown3ae22e82010-12-25 15:32:27 +0100235 .pm = &spi_pm,
David Brownell8ae12a02006-01-08 13:34:19 -0800236};
237EXPORT_SYMBOL_GPL(spi_bus_type);
238
David Brownellb8852442006-01-08 13:34:23 -0800239
240static int spi_drv_probe(struct device *dev)
241{
242 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
243
244 return sdrv->probe(to_spi_device(dev));
245}
246
247static int spi_drv_remove(struct device *dev)
248{
249 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
250
251 return sdrv->remove(to_spi_device(dev));
252}
253
254static void spi_drv_shutdown(struct device *dev)
255{
256 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
257
258 sdrv->shutdown(to_spi_device(dev));
259}
260
David Brownell33e34dc2007-05-08 00:32:21 -0700261/**
262 * spi_register_driver - register a SPI driver
263 * @sdrv: the driver to register
264 * Context: can sleep
265 */
David Brownellb8852442006-01-08 13:34:23 -0800266int spi_register_driver(struct spi_driver *sdrv)
267{
268 sdrv->driver.bus = &spi_bus_type;
269 if (sdrv->probe)
270 sdrv->driver.probe = spi_drv_probe;
271 if (sdrv->remove)
272 sdrv->driver.remove = spi_drv_remove;
273 if (sdrv->shutdown)
274 sdrv->driver.shutdown = spi_drv_shutdown;
275 return driver_register(&sdrv->driver);
276}
277EXPORT_SYMBOL_GPL(spi_register_driver);
278
David Brownell8ae12a02006-01-08 13:34:19 -0800279/*-------------------------------------------------------------------------*/
280
281/* SPI devices should normally not be created by SPI device drivers; that
282 * would make them board-specific. Similarly with SPI master drivers.
283 * Device registration normally goes into like arch/.../mach.../board-YYY.c
284 * with other readonly (flashable) information about mainboard devices.
285 */
286
287struct boardinfo {
288 struct list_head list;
Feng Tang2b9603a2010-08-02 15:52:15 +0800289 struct spi_board_info board_info;
David Brownell8ae12a02006-01-08 13:34:19 -0800290};
291
292static LIST_HEAD(board_list);
Feng Tang2b9603a2010-08-02 15:52:15 +0800293static LIST_HEAD(spi_master_list);
294
295/*
296 * Used to protect add/del opertion for board_info list and
297 * spi_master list, and their matching process
298 */
Matthias Kaehlcke94040822007-07-17 04:04:16 -0700299static DEFINE_MUTEX(board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800300
Grant Likelydc87c982008-05-15 16:50:22 -0600301/**
302 * spi_alloc_device - Allocate a new SPI device
303 * @master: Controller to which device is connected
304 * Context: can sleep
305 *
306 * Allows a driver to allocate and initialize a spi_device without
307 * registering it immediately. This allows a driver to directly
308 * fill the spi_device with device parameters before calling
309 * spi_add_device() on it.
310 *
311 * Caller is responsible to call spi_add_device() on the returned
312 * spi_device structure to add it to the SPI master. If the caller
313 * needs to discard the spi_device without adding it, then it should
314 * call spi_dev_put() on it.
315 *
316 * Returns a pointer to the new device, or NULL.
317 */
318struct spi_device *spi_alloc_device(struct spi_master *master)
319{
320 struct spi_device *spi;
321 struct device *dev = master->dev.parent;
322
323 if (!spi_master_get(master))
324 return NULL;
325
326 spi = kzalloc(sizeof *spi, GFP_KERNEL);
327 if (!spi) {
328 dev_err(dev, "cannot alloc spi_device\n");
329 spi_master_put(master);
330 return NULL;
331 }
332
333 spi->master = master;
Laurent Pinchart178db7d2011-12-12 01:15:06 +0100334 spi->dev.parent = &master->dev;
Grant Likelydc87c982008-05-15 16:50:22 -0600335 spi->dev.bus = &spi_bus_type;
336 spi->dev.release = spidev_release;
Andreas Larsson446411e2013-02-13 14:20:25 +0100337 spi->cs_gpio = -ENOENT;
Grant Likelydc87c982008-05-15 16:50:22 -0600338 device_initialize(&spi->dev);
339 return spi;
340}
341EXPORT_SYMBOL_GPL(spi_alloc_device);
342
343/**
344 * spi_add_device - Add spi_device allocated with spi_alloc_device
345 * @spi: spi_device to register
346 *
347 * Companion function to spi_alloc_device. Devices allocated with
348 * spi_alloc_device can be added onto the spi bus with this function.
349 *
David Brownelle48880e2008-08-15 00:40:44 -0700350 * Returns 0 on success; negative errno on failure
Grant Likelydc87c982008-05-15 16:50:22 -0600351 */
352int spi_add_device(struct spi_device *spi)
353{
David Brownelle48880e2008-08-15 00:40:44 -0700354 static DEFINE_MUTEX(spi_add_lock);
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100355 struct spi_master *master = spi->master;
356 struct device *dev = master->dev.parent;
Roman Tereshonkov8ec130a2010-04-16 09:52:59 +0000357 struct device *d;
Grant Likelydc87c982008-05-15 16:50:22 -0600358 int status;
359
360 /* Chipselects are numbered 0..max; validate. */
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100361 if (spi->chip_select >= master->num_chipselect) {
Grant Likelydc87c982008-05-15 16:50:22 -0600362 dev_err(dev, "cs%d >= max %d\n",
363 spi->chip_select,
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100364 master->num_chipselect);
Grant Likelydc87c982008-05-15 16:50:22 -0600365 return -EINVAL;
366 }
367
368 /* Set the bus ID string */
Kay Sievers35f74fc2009-01-06 10:44:37 -0800369 dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
Grant Likelydc87c982008-05-15 16:50:22 -0600370 spi->chip_select);
371
David Brownelle48880e2008-08-15 00:40:44 -0700372
373 /* We need to make sure there's no other device with this
374 * chipselect **BEFORE** we call setup(), else we'll trash
375 * its configuration. Lock against concurrent add() calls.
376 */
377 mutex_lock(&spi_add_lock);
378
Roman Tereshonkov8ec130a2010-04-16 09:52:59 +0000379 d = bus_find_device_by_name(&spi_bus_type, NULL, dev_name(&spi->dev));
380 if (d != NULL) {
David Brownelle48880e2008-08-15 00:40:44 -0700381 dev_err(dev, "chipselect %d already in use\n",
382 spi->chip_select);
Roman Tereshonkov8ec130a2010-04-16 09:52:59 +0000383 put_device(d);
David Brownelle48880e2008-08-15 00:40:44 -0700384 status = -EBUSY;
385 goto done;
386 }
387
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +0100388 if (master->cs_gpios)
389 spi->cs_gpio = master->cs_gpios[spi->chip_select];
390
David Brownelle48880e2008-08-15 00:40:44 -0700391 /* Drivers may modify this initial i/o setup, but will
392 * normally rely on the device being setup. Devices
393 * using SPI_CS_HIGH can't coexist well otherwise...
394 */
David Brownell7d077192009-06-17 16:26:03 -0700395 status = spi_setup(spi);
Grant Likelydc87c982008-05-15 16:50:22 -0600396 if (status < 0) {
Linus Walleijeb288a12010-10-21 21:06:44 +0200397 dev_err(dev, "can't setup %s, status %d\n",
398 dev_name(&spi->dev), status);
David Brownelle48880e2008-08-15 00:40:44 -0700399 goto done;
Grant Likelydc87c982008-05-15 16:50:22 -0600400 }
401
David Brownelle48880e2008-08-15 00:40:44 -0700402 /* Device may be bound to an active driver when this returns */
Grant Likelydc87c982008-05-15 16:50:22 -0600403 status = device_add(&spi->dev);
David Brownelle48880e2008-08-15 00:40:44 -0700404 if (status < 0)
Linus Walleijeb288a12010-10-21 21:06:44 +0200405 dev_err(dev, "can't add %s, status %d\n",
406 dev_name(&spi->dev), status);
David Brownelle48880e2008-08-15 00:40:44 -0700407 else
Kay Sievers35f74fc2009-01-06 10:44:37 -0800408 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
Grant Likelydc87c982008-05-15 16:50:22 -0600409
David Brownelle48880e2008-08-15 00:40:44 -0700410done:
411 mutex_unlock(&spi_add_lock);
412 return status;
Grant Likelydc87c982008-05-15 16:50:22 -0600413}
414EXPORT_SYMBOL_GPL(spi_add_device);
David Brownell8ae12a02006-01-08 13:34:19 -0800415
David Brownell33e34dc2007-05-08 00:32:21 -0700416/**
417 * spi_new_device - instantiate one new SPI device
418 * @master: Controller to which device is connected
419 * @chip: Describes the SPI device
420 * Context: can sleep
421 *
422 * On typical mainboards, this is purely internal; and it's not needed
David Brownell8ae12a02006-01-08 13:34:19 -0800423 * after board init creates the hard-wired devices. Some development
424 * platforms may not be able to use spi_register_board_info though, and
425 * this is exported so that for example a USB or parport based adapter
426 * driver could add devices (which it would learn about out-of-band).
David Brownell082c8cb2007-07-31 00:39:45 -0700427 *
428 * Returns the new device, or NULL.
David Brownell8ae12a02006-01-08 13:34:19 -0800429 */
Adrian Bunke9d5a462007-03-26 21:32:23 -0800430struct spi_device *spi_new_device(struct spi_master *master,
431 struct spi_board_info *chip)
David Brownell8ae12a02006-01-08 13:34:19 -0800432{
433 struct spi_device *proxy;
David Brownell8ae12a02006-01-08 13:34:19 -0800434 int status;
435
David Brownell082c8cb2007-07-31 00:39:45 -0700436 /* NOTE: caller did any chip->bus_num checks necessary.
437 *
438 * Also, unless we change the return value convention to use
439 * error-or-pointer (not NULL-or-pointer), troubleshootability
440 * suggests syslogged diagnostics are best here (ugh).
441 */
442
Grant Likelydc87c982008-05-15 16:50:22 -0600443 proxy = spi_alloc_device(master);
444 if (!proxy)
David Brownell8ae12a02006-01-08 13:34:19 -0800445 return NULL;
446
Grant Likely102eb972008-07-23 21:29:55 -0700447 WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
448
David Brownell8ae12a02006-01-08 13:34:19 -0800449 proxy->chip_select = chip->chip_select;
450 proxy->max_speed_hz = chip->max_speed_hz;
David Brownell980a01c2006-06-28 07:47:15 -0700451 proxy->mode = chip->mode;
David Brownell8ae12a02006-01-08 13:34:19 -0800452 proxy->irq = chip->irq;
Grant Likely102eb972008-07-23 21:29:55 -0700453 strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
David Brownell8ae12a02006-01-08 13:34:19 -0800454 proxy->dev.platform_data = (void *) chip->platform_data;
455 proxy->controller_data = chip->controller_data;
456 proxy->controller_state = NULL;
David Brownell8ae12a02006-01-08 13:34:19 -0800457
Grant Likelydc87c982008-05-15 16:50:22 -0600458 status = spi_add_device(proxy);
David Brownell8ae12a02006-01-08 13:34:19 -0800459 if (status < 0) {
Grant Likelydc87c982008-05-15 16:50:22 -0600460 spi_dev_put(proxy);
461 return NULL;
David Brownell8ae12a02006-01-08 13:34:19 -0800462 }
463
David Brownell8ae12a02006-01-08 13:34:19 -0800464 return proxy;
465}
466EXPORT_SYMBOL_GPL(spi_new_device);
467
Feng Tang2b9603a2010-08-02 15:52:15 +0800468static void spi_match_master_to_boardinfo(struct spi_master *master,
469 struct spi_board_info *bi)
470{
471 struct spi_device *dev;
472
473 if (master->bus_num != bi->bus_num)
474 return;
475
476 dev = spi_new_device(master, bi);
477 if (!dev)
478 dev_err(master->dev.parent, "can't create new device for %s\n",
479 bi->modalias);
480}
481
David Brownell33e34dc2007-05-08 00:32:21 -0700482/**
483 * spi_register_board_info - register SPI devices for a given board
484 * @info: array of chip descriptors
485 * @n: how many descriptors are provided
486 * Context: can sleep
487 *
David Brownell8ae12a02006-01-08 13:34:19 -0800488 * Board-specific early init code calls this (probably during arch_initcall)
489 * with segments of the SPI device table. Any device nodes are created later,
490 * after the relevant parent SPI controller (bus_num) is defined. We keep
491 * this table of devices forever, so that reloading a controller driver will
492 * not make Linux forget about these hard-wired devices.
493 *
494 * Other code can also call this, e.g. a particular add-on board might provide
495 * SPI devices through its expansion connector, so code initializing that board
496 * would naturally declare its SPI devices.
497 *
498 * The board info passed can safely be __initdata ... but be careful of
499 * any embedded pointers (platform_data, etc), they're copied as-is.
500 */
Grant Likelyfd4a3192012-12-07 16:57:14 +0000501int spi_register_board_info(struct spi_board_info const *info, unsigned n)
David Brownell8ae12a02006-01-08 13:34:19 -0800502{
Feng Tang2b9603a2010-08-02 15:52:15 +0800503 struct boardinfo *bi;
504 int i;
David Brownell8ae12a02006-01-08 13:34:19 -0800505
Feng Tang2b9603a2010-08-02 15:52:15 +0800506 bi = kzalloc(n * sizeof(*bi), GFP_KERNEL);
David Brownell8ae12a02006-01-08 13:34:19 -0800507 if (!bi)
508 return -ENOMEM;
David Brownell8ae12a02006-01-08 13:34:19 -0800509
Feng Tang2b9603a2010-08-02 15:52:15 +0800510 for (i = 0; i < n; i++, bi++, info++) {
511 struct spi_master *master;
David Brownell8ae12a02006-01-08 13:34:19 -0800512
Feng Tang2b9603a2010-08-02 15:52:15 +0800513 memcpy(&bi->board_info, info, sizeof(*info));
514 mutex_lock(&board_lock);
515 list_add_tail(&bi->list, &board_list);
516 list_for_each_entry(master, &spi_master_list, list)
517 spi_match_master_to_boardinfo(master, &bi->board_info);
518 mutex_unlock(&board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800519 }
Feng Tang2b9603a2010-08-02 15:52:15 +0800520
521 return 0;
David Brownell8ae12a02006-01-08 13:34:19 -0800522}
523
524/*-------------------------------------------------------------------------*/
525
Linus Walleijffbbdd212012-02-22 10:05:38 +0100526/**
527 * spi_pump_messages - kthread work function which processes spi message queue
528 * @work: pointer to kthread work struct contained in the master struct
529 *
530 * This function checks if there is any spi message in the queue that
531 * needs processing and if so call out to the driver to initialize hardware
532 * and transfer each message.
533 *
534 */
535static void spi_pump_messages(struct kthread_work *work)
536{
537 struct spi_master *master =
538 container_of(work, struct spi_master, pump_messages);
539 unsigned long flags;
540 bool was_busy = false;
541 int ret;
542
543 /* Lock queue and check for queue work */
544 spin_lock_irqsave(&master->queue_lock, flags);
545 if (list_empty(&master->queue) || !master->running) {
Bryan Freedb0b36b82013-03-13 11:17:40 -0700546 if (!master->busy) {
547 spin_unlock_irqrestore(&master->queue_lock, flags);
548 return;
Linus Walleijffbbdd212012-02-22 10:05:38 +0100549 }
550 master->busy = false;
551 spin_unlock_irqrestore(&master->queue_lock, flags);
Bryan Freedb0b36b82013-03-13 11:17:40 -0700552 if (master->unprepare_transfer_hardware &&
553 master->unprepare_transfer_hardware(master))
554 dev_err(&master->dev,
555 "failed to unprepare transfer hardware\n");
Linus Walleijffbbdd212012-02-22 10:05:38 +0100556 return;
557 }
558
559 /* Make sure we are not already running a message */
560 if (master->cur_msg) {
561 spin_unlock_irqrestore(&master->queue_lock, flags);
562 return;
563 }
564 /* Extract head of queue */
565 master->cur_msg =
566 list_entry(master->queue.next, struct spi_message, queue);
567
568 list_del_init(&master->cur_msg->queue);
569 if (master->busy)
570 was_busy = true;
571 else
572 master->busy = true;
573 spin_unlock_irqrestore(&master->queue_lock, flags);
574
Shubhrajyoti D7dfd2bd2012-05-10 19:20:41 +0530575 if (!was_busy && master->prepare_transfer_hardware) {
Linus Walleijffbbdd212012-02-22 10:05:38 +0100576 ret = master->prepare_transfer_hardware(master);
577 if (ret) {
578 dev_err(&master->dev,
579 "failed to prepare transfer hardware\n");
580 return;
581 }
582 }
583
584 ret = master->transfer_one_message(master, master->cur_msg);
585 if (ret) {
586 dev_err(&master->dev,
Daniel Santos4371c272014-01-05 17:39:26 -0600587 "failed to transfer one message from queue: %d\n", ret);
588 master->cur_msg->status = ret;
589 spi_finalize_current_message(master);
Linus Walleijffbbdd212012-02-22 10:05:38 +0100590 return;
591 }
592}
593
594static int spi_init_queue(struct spi_master *master)
595{
596 struct sched_param param = { .sched_priority = MAX_RT_PRIO - 1 };
597
598 INIT_LIST_HEAD(&master->queue);
599 spin_lock_init(&master->queue_lock);
600
601 master->running = false;
602 master->busy = false;
603
604 init_kthread_worker(&master->kworker);
605 master->kworker_task = kthread_run(kthread_worker_fn,
606 &master->kworker,
607 dev_name(&master->dev));
608 if (IS_ERR(master->kworker_task)) {
609 dev_err(&master->dev, "failed to create message pump task\n");
610 return -ENOMEM;
611 }
612 init_kthread_work(&master->pump_messages, spi_pump_messages);
613
614 /*
615 * Master config will indicate if this controller should run the
616 * message pump with high (realtime) priority to reduce the transfer
617 * latency on the bus by minimising the delay between a transfer
618 * request and the scheduling of the message pump thread. Without this
619 * setting the message pump thread will remain at default priority.
620 */
621 if (master->rt) {
622 dev_info(&master->dev,
623 "will run message pump with realtime priority\n");
624 sched_setscheduler(master->kworker_task, SCHED_FIFO, &param);
625 }
626
627 return 0;
628}
629
630/**
631 * spi_get_next_queued_message() - called by driver to check for queued
632 * messages
633 * @master: the master to check for queued messages
634 *
635 * If there are more messages in the queue, the next message is returned from
636 * this call.
637 */
638struct spi_message *spi_get_next_queued_message(struct spi_master *master)
639{
640 struct spi_message *next;
641 unsigned long flags;
642
643 /* get a pointer to the next message, if any */
644 spin_lock_irqsave(&master->queue_lock, flags);
645 if (list_empty(&master->queue))
646 next = NULL;
647 else
648 next = list_entry(master->queue.next,
649 struct spi_message, queue);
650 spin_unlock_irqrestore(&master->queue_lock, flags);
651
652 return next;
653}
654EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
655
656/**
657 * spi_finalize_current_message() - the current message is complete
658 * @master: the master to return the message to
659 *
660 * Called by the driver to notify the core that the message in the front of the
661 * queue is complete and can be removed from the queue.
662 */
663void spi_finalize_current_message(struct spi_master *master)
664{
665 struct spi_message *mesg;
666 unsigned long flags;
667
668 spin_lock_irqsave(&master->queue_lock, flags);
669 mesg = master->cur_msg;
670 master->cur_msg = NULL;
671
672 queue_kthread_work(&master->kworker, &master->pump_messages);
673 spin_unlock_irqrestore(&master->queue_lock, flags);
674
675 mesg->state = NULL;
676 if (mesg->complete)
677 mesg->complete(mesg->context);
678}
679EXPORT_SYMBOL_GPL(spi_finalize_current_message);
680
681static int spi_start_queue(struct spi_master *master)
682{
683 unsigned long flags;
684
685 spin_lock_irqsave(&master->queue_lock, flags);
686
687 if (master->running || master->busy) {
688 spin_unlock_irqrestore(&master->queue_lock, flags);
689 return -EBUSY;
690 }
691
692 master->running = true;
693 master->cur_msg = NULL;
694 spin_unlock_irqrestore(&master->queue_lock, flags);
695
696 queue_kthread_work(&master->kworker, &master->pump_messages);
697
698 return 0;
699}
700
701static int spi_stop_queue(struct spi_master *master)
702{
703 unsigned long flags;
704 unsigned limit = 500;
705 int ret = 0;
706
707 spin_lock_irqsave(&master->queue_lock, flags);
708
709 /*
710 * This is a bit lame, but is optimized for the common execution path.
711 * A wait_queue on the master->busy could be used, but then the common
712 * execution path (pump_messages) would be required to call wake_up or
713 * friends on every SPI message. Do this instead.
714 */
715 while ((!list_empty(&master->queue) || master->busy) && limit--) {
716 spin_unlock_irqrestore(&master->queue_lock, flags);
717 msleep(10);
718 spin_lock_irqsave(&master->queue_lock, flags);
719 }
720
721 if (!list_empty(&master->queue) || master->busy)
722 ret = -EBUSY;
723 else
724 master->running = false;
725
726 spin_unlock_irqrestore(&master->queue_lock, flags);
727
728 if (ret) {
729 dev_warn(&master->dev,
730 "could not stop message queue\n");
731 return ret;
732 }
733 return ret;
734}
735
736static int spi_destroy_queue(struct spi_master *master)
737{
738 int ret;
739
740 ret = spi_stop_queue(master);
741
742 /*
743 * flush_kthread_worker will block until all work is done.
744 * If the reason that stop_queue timed out is that the work will never
745 * finish, then it does no good to call flush/stop thread, so
746 * return anyway.
747 */
748 if (ret) {
749 dev_err(&master->dev, "problem destroying queue\n");
750 return ret;
751 }
752
753 flush_kthread_worker(&master->kworker);
754 kthread_stop(master->kworker_task);
755
756 return 0;
757}
758
759/**
760 * spi_queued_transfer - transfer function for queued transfers
761 * @spi: spi device which is requesting transfer
762 * @msg: spi message which is to handled is queued to driver queue
763 */
764static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
765{
766 struct spi_master *master = spi->master;
767 unsigned long flags;
768
769 spin_lock_irqsave(&master->queue_lock, flags);
770
771 if (!master->running) {
772 spin_unlock_irqrestore(&master->queue_lock, flags);
773 return -ESHUTDOWN;
774 }
775 msg->actual_length = 0;
776 msg->status = -EINPROGRESS;
777
778 list_add_tail(&msg->queue, &master->queue);
779 if (master->running && !master->busy)
780 queue_kthread_work(&master->kworker, &master->pump_messages);
781
782 spin_unlock_irqrestore(&master->queue_lock, flags);
783 return 0;
784}
785
786static int spi_master_initialize_queue(struct spi_master *master)
787{
788 int ret;
789
790 master->queued = true;
791 master->transfer = spi_queued_transfer;
792
793 /* Initialize and start queue */
794 ret = spi_init_queue(master);
795 if (ret) {
796 dev_err(&master->dev, "problem initializing queue\n");
797 goto err_init_queue;
798 }
799 ret = spi_start_queue(master);
800 if (ret) {
801 dev_err(&master->dev, "problem starting queue\n");
802 goto err_start_queue;
803 }
804
805 return 0;
806
807err_start_queue:
808err_init_queue:
809 spi_destroy_queue(master);
810 return ret;
811}
812
813/*-------------------------------------------------------------------------*/
814
Andreas Larsson7cb94362012-12-04 15:09:38 +0100815#if defined(CONFIG_OF)
Grant Likelyd57a4282012-04-07 14:16:53 -0600816/**
817 * of_register_spi_devices() - Register child devices onto the SPI bus
818 * @master: Pointer to spi_master device
819 *
820 * Registers an spi_device for each child node of master node which has a 'reg'
821 * property.
822 */
823static void of_register_spi_devices(struct spi_master *master)
824{
825 struct spi_device *spi;
826 struct device_node *nc;
827 const __be32 *prop;
David Daneycb719412012-05-22 15:47:19 -0700828 char modalias[SPI_NAME_SIZE + 4];
Grant Likelyd57a4282012-04-07 14:16:53 -0600829 int rc;
830 int len;
831
832 if (!master->dev.of_node)
833 return;
834
Alexander Sverdlinf3b61592012-11-29 08:59:29 +0100835 for_each_available_child_of_node(master->dev.of_node, nc) {
Grant Likelyd57a4282012-04-07 14:16:53 -0600836 /* Alloc an spi_device */
837 spi = spi_alloc_device(master);
838 if (!spi) {
839 dev_err(&master->dev, "spi_device alloc error for %s\n",
840 nc->full_name);
841 spi_dev_put(spi);
842 continue;
843 }
844
845 /* Select device driver */
846 if (of_modalias_node(nc, spi->modalias,
847 sizeof(spi->modalias)) < 0) {
848 dev_err(&master->dev, "cannot find modalias for %s\n",
849 nc->full_name);
850 spi_dev_put(spi);
851 continue;
852 }
853
854 /* Device address */
855 prop = of_get_property(nc, "reg", &len);
856 if (!prop || len < sizeof(*prop)) {
857 dev_err(&master->dev, "%s has no 'reg' property\n",
858 nc->full_name);
859 spi_dev_put(spi);
860 continue;
861 }
862 spi->chip_select = be32_to_cpup(prop);
863
864 /* Mode (clock phase/polarity/etc.) */
865 if (of_find_property(nc, "spi-cpha", NULL))
866 spi->mode |= SPI_CPHA;
867 if (of_find_property(nc, "spi-cpol", NULL))
868 spi->mode |= SPI_CPOL;
869 if (of_find_property(nc, "spi-cs-high", NULL))
870 spi->mode |= SPI_CS_HIGH;
Lars-Peter Clausenc20151d2012-12-06 16:55:33 +0100871 if (of_find_property(nc, "spi-3wire", NULL))
872 spi->mode |= SPI_3WIRE;
Grant Likelyd57a4282012-04-07 14:16:53 -0600873
874 /* Device speed */
875 prop = of_get_property(nc, "spi-max-frequency", &len);
876 if (!prop || len < sizeof(*prop)) {
877 dev_err(&master->dev, "%s has no 'spi-max-frequency' property\n",
878 nc->full_name);
879 spi_dev_put(spi);
880 continue;
881 }
882 spi->max_speed_hz = be32_to_cpup(prop);
883
884 /* IRQ */
885 spi->irq = irq_of_parse_and_map(nc, 0);
886
887 /* Store a pointer to the node in the device structure */
888 of_node_get(nc);
889 spi->dev.of_node = nc;
890
891 /* Register the new device */
David Daneycb719412012-05-22 15:47:19 -0700892 snprintf(modalias, sizeof(modalias), "%s%s", SPI_MODULE_PREFIX,
893 spi->modalias);
894 request_module(modalias);
Grant Likelyd57a4282012-04-07 14:16:53 -0600895 rc = spi_add_device(spi);
896 if (rc) {
897 dev_err(&master->dev, "spi_device register error %s\n",
898 nc->full_name);
899 spi_dev_put(spi);
900 }
901
902 }
903}
904#else
905static void of_register_spi_devices(struct spi_master *master) { }
906#endif
907
Mika Westerberg64bee4d2012-11-30 12:37:53 +0100908#ifdef CONFIG_ACPI
909static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
910{
911 struct spi_device *spi = data;
912
913 if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
914 struct acpi_resource_spi_serialbus *sb;
915
916 sb = &ares->data.spi_serial_bus;
917 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
918 spi->chip_select = sb->device_selection;
919 spi->max_speed_hz = sb->connection_speed;
920
921 if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
922 spi->mode |= SPI_CPHA;
923 if (sb->clock_polarity == ACPI_SPI_START_HIGH)
924 spi->mode |= SPI_CPOL;
925 if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
926 spi->mode |= SPI_CS_HIGH;
927 }
928 } else if (spi->irq < 0) {
929 struct resource r;
930
931 if (acpi_dev_resource_interrupt(ares, 0, &r))
932 spi->irq = r.start;
933 }
934
935 /* Always tell the ACPI core to skip this resource */
936 return 1;
937}
938
939static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
940 void *data, void **return_value)
941{
942 struct spi_master *master = data;
943 struct list_head resource_list;
944 struct acpi_device *adev;
945 struct spi_device *spi;
946 int ret;
947
948 if (acpi_bus_get_device(handle, &adev))
949 return AE_OK;
950 if (acpi_bus_get_status(adev) || !adev->status.present)
951 return AE_OK;
952
953 spi = spi_alloc_device(master);
954 if (!spi) {
955 dev_err(&master->dev, "failed to allocate SPI device for %s\n",
956 dev_name(&adev->dev));
957 return AE_NO_MEMORY;
958 }
959
960 ACPI_HANDLE_SET(&spi->dev, handle);
961 spi->irq = -1;
962
963 INIT_LIST_HEAD(&resource_list);
964 ret = acpi_dev_get_resources(adev, &resource_list,
965 acpi_spi_add_resource, spi);
966 acpi_dev_free_resource_list(&resource_list);
967
968 if (ret < 0 || !spi->max_speed_hz) {
969 spi_dev_put(spi);
970 return AE_OK;
971 }
972
973 strlcpy(spi->modalias, dev_name(&adev->dev), sizeof(spi->modalias));
974 if (spi_add_device(spi)) {
975 dev_err(&master->dev, "failed to add SPI device %s from ACPI\n",
976 dev_name(&adev->dev));
977 spi_dev_put(spi);
978 }
979
980 return AE_OK;
981}
982
983static void acpi_register_spi_devices(struct spi_master *master)
984{
985 acpi_status status;
986 acpi_handle handle;
987
Rafael J. Wysocki29896172013-04-01 00:21:08 +0000988 handle = ACPI_HANDLE(master->dev.parent);
Mika Westerberg64bee4d2012-11-30 12:37:53 +0100989 if (!handle)
990 return;
991
992 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
993 acpi_spi_add_device, NULL,
994 master, NULL);
995 if (ACPI_FAILURE(status))
996 dev_warn(&master->dev, "failed to enumerate SPI slaves\n");
997}
998#else
999static inline void acpi_register_spi_devices(struct spi_master *master) {}
1000#endif /* CONFIG_ACPI */
1001
Tony Jones49dce682007-10-16 01:27:48 -07001002static void spi_master_release(struct device *dev)
David Brownell8ae12a02006-01-08 13:34:19 -08001003{
1004 struct spi_master *master;
1005
Tony Jones49dce682007-10-16 01:27:48 -07001006 master = container_of(dev, struct spi_master, dev);
David Brownell8ae12a02006-01-08 13:34:19 -08001007 kfree(master);
1008}
1009
1010static struct class spi_master_class = {
1011 .name = "spi_master",
1012 .owner = THIS_MODULE,
Tony Jones49dce682007-10-16 01:27:48 -07001013 .dev_release = spi_master_release,
David Brownell8ae12a02006-01-08 13:34:19 -08001014};
1015
1016
Linus Walleijffbbdd212012-02-22 10:05:38 +01001017
David Brownell8ae12a02006-01-08 13:34:19 -08001018/**
1019 * spi_alloc_master - allocate SPI master controller
1020 * @dev: the controller, possibly using the platform_bus
David Brownell33e34dc2007-05-08 00:32:21 -07001021 * @size: how much zeroed driver-private data to allocate; the pointer to this
Tony Jones49dce682007-10-16 01:27:48 -07001022 * memory is in the driver_data field of the returned device,
David Brownell0c868462006-01-08 13:34:25 -08001023 * accessible with spi_master_get_devdata().
David Brownell33e34dc2007-05-08 00:32:21 -07001024 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001025 *
1026 * This call is used only by SPI master controller drivers, which are the
1027 * only ones directly touching chip registers. It's how they allocate
dmitry pervushinba1a0512006-05-20 15:00:14 -07001028 * an spi_master structure, prior to calling spi_register_master().
David Brownell8ae12a02006-01-08 13:34:19 -08001029 *
1030 * This must be called from context that can sleep. It returns the SPI
1031 * master structure on success, else NULL.
1032 *
1033 * The caller is responsible for assigning the bus number and initializing
dmitry pervushinba1a0512006-05-20 15:00:14 -07001034 * the master's methods before calling spi_register_master(); and (after errors
Uwe Kleine-Königeb4af0f2012-02-23 10:40:14 +01001035 * adding the device) calling spi_master_put() and kfree() to prevent a memory
1036 * leak.
David Brownell8ae12a02006-01-08 13:34:19 -08001037 */
Adrian Bunke9d5a462007-03-26 21:32:23 -08001038struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
David Brownell8ae12a02006-01-08 13:34:19 -08001039{
1040 struct spi_master *master;
1041
David Brownell0c868462006-01-08 13:34:25 -08001042 if (!dev)
1043 return NULL;
1044
Christoph Lametere94b1762006-12-06 20:33:17 -08001045 master = kzalloc(size + sizeof *master, GFP_KERNEL);
David Brownell8ae12a02006-01-08 13:34:19 -08001046 if (!master)
1047 return NULL;
1048
Tony Jones49dce682007-10-16 01:27:48 -07001049 device_initialize(&master->dev);
Grant Likely1e8a52e2012-05-19 23:42:08 -06001050 master->bus_num = -1;
1051 master->num_chipselect = 1;
Tony Jones49dce682007-10-16 01:27:48 -07001052 master->dev.class = &spi_master_class;
1053 master->dev.parent = get_device(dev);
David Brownell0c868462006-01-08 13:34:25 -08001054 spi_master_set_devdata(master, &master[1]);
David Brownell8ae12a02006-01-08 13:34:19 -08001055
1056 return master;
1057}
1058EXPORT_SYMBOL_GPL(spi_alloc_master);
1059
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001060#ifdef CONFIG_OF
1061static int of_spi_register_master(struct spi_master *master)
1062{
Grant Likelye80beb22013-02-12 17:48:37 +00001063 int nb, i, *cs;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001064 struct device_node *np = master->dev.of_node;
1065
1066 if (!np)
1067 return 0;
1068
1069 nb = of_gpio_named_count(np, "cs-gpios");
Grant Likelye80beb22013-02-12 17:48:37 +00001070 master->num_chipselect = max(nb, (int)master->num_chipselect);
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001071
Andreas Larsson8ec5d842013-02-13 14:23:24 +01001072 /* Return error only for an incorrectly formed cs-gpios property */
1073 if (nb == 0 || nb == -ENOENT)
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001074 return 0;
Andreas Larsson8ec5d842013-02-13 14:23:24 +01001075 else if (nb < 0)
1076 return nb;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001077
1078 cs = devm_kzalloc(&master->dev,
1079 sizeof(int) * master->num_chipselect,
1080 GFP_KERNEL);
1081 master->cs_gpios = cs;
1082
1083 if (!master->cs_gpios)
1084 return -ENOMEM;
1085
Andreas Larsson0da83bb2013-01-29 15:53:40 +01001086 for (i = 0; i < master->num_chipselect; i++)
Andreas Larsson446411e2013-02-13 14:20:25 +01001087 cs[i] = -ENOENT;
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001088
1089 for (i = 0; i < nb; i++)
1090 cs[i] = of_get_named_gpio(np, "cs-gpios", i);
1091
1092 return 0;
1093}
1094#else
1095static int of_spi_register_master(struct spi_master *master)
1096{
1097 return 0;
1098}
1099#endif
1100
David Brownell8ae12a02006-01-08 13:34:19 -08001101/**
1102 * spi_register_master - register SPI master controller
1103 * @master: initialized master, originally from spi_alloc_master()
David Brownell33e34dc2007-05-08 00:32:21 -07001104 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001105 *
1106 * SPI master controllers connect to their drivers using some non-SPI bus,
1107 * such as the platform bus. The final stage of probe() in that code
1108 * includes calling spi_register_master() to hook up to this SPI bus glue.
1109 *
1110 * SPI controllers use board specific (often SOC specific) bus numbers,
1111 * and board-specific addressing for SPI devices combines those numbers
1112 * with chip select numbers. Since SPI does not directly support dynamic
1113 * device identification, boards need configuration tables telling which
1114 * chip is at which address.
1115 *
1116 * This must be called from context that can sleep. It returns zero on
1117 * success, else a negative error code (dropping the master's refcount).
David Brownell0c868462006-01-08 13:34:25 -08001118 * After a successful return, the caller is responsible for calling
1119 * spi_unregister_master().
David Brownell8ae12a02006-01-08 13:34:19 -08001120 */
Adrian Bunke9d5a462007-03-26 21:32:23 -08001121int spi_register_master(struct spi_master *master)
David Brownell8ae12a02006-01-08 13:34:19 -08001122{
David Brownelle44a45a2007-06-03 13:50:40 -07001123 static atomic_t dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
Tony Jones49dce682007-10-16 01:27:48 -07001124 struct device *dev = master->dev.parent;
Feng Tang2b9603a2010-08-02 15:52:15 +08001125 struct boardinfo *bi;
David Brownell8ae12a02006-01-08 13:34:19 -08001126 int status = -ENODEV;
1127 int dynamic = 0;
1128
David Brownell0c868462006-01-08 13:34:25 -08001129 if (!dev)
1130 return -ENODEV;
1131
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +01001132 status = of_spi_register_master(master);
1133 if (status)
1134 return status;
1135
David Brownell082c8cb2007-07-31 00:39:45 -07001136 /* even if it's just one always-selected device, there must
1137 * be at least one chipselect
1138 */
1139 if (master->num_chipselect == 0)
1140 return -EINVAL;
1141
Grant Likelybb297852012-12-21 19:32:09 +00001142 if ((master->bus_num < 0) && master->dev.of_node)
1143 master->bus_num = of_alias_get_id(master->dev.of_node, "spi");
1144
David Brownell8ae12a02006-01-08 13:34:19 -08001145 /* convention: dynamically assigned bus IDs count down from the max */
David Brownella020ed72006-04-03 15:49:04 -07001146 if (master->bus_num < 0) {
David Brownell082c8cb2007-07-31 00:39:45 -07001147 /* FIXME switch to an IDR based scheme, something like
1148 * I2C now uses, so we can't run out of "dynamic" IDs
1149 */
David Brownell8ae12a02006-01-08 13:34:19 -08001150 master->bus_num = atomic_dec_return(&dyn_bus_id);
David Brownellb8852442006-01-08 13:34:23 -08001151 dynamic = 1;
David Brownell8ae12a02006-01-08 13:34:19 -08001152 }
1153
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001154 spin_lock_init(&master->bus_lock_spinlock);
1155 mutex_init(&master->bus_lock_mutex);
1156 master->bus_lock_flag = 0;
1157
David Brownell8ae12a02006-01-08 13:34:19 -08001158 /* register the device, then userspace will see it.
1159 * registration fails if the bus ID is in use.
1160 */
Kay Sievers35f74fc2009-01-06 10:44:37 -08001161 dev_set_name(&master->dev, "spi%u", master->bus_num);
Tony Jones49dce682007-10-16 01:27:48 -07001162 status = device_add(&master->dev);
David Brownellb8852442006-01-08 13:34:23 -08001163 if (status < 0)
David Brownell8ae12a02006-01-08 13:34:19 -08001164 goto done;
Kay Sievers35f74fc2009-01-06 10:44:37 -08001165 dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
David Brownell8ae12a02006-01-08 13:34:19 -08001166 dynamic ? " (dynamic)" : "");
1167
Linus Walleijffbbdd212012-02-22 10:05:38 +01001168 /* If we're using a queued driver, start the queue */
1169 if (master->transfer)
1170 dev_info(dev, "master is unqueued, this is deprecated\n");
1171 else {
1172 status = spi_master_initialize_queue(master);
1173 if (status) {
1174 device_unregister(&master->dev);
1175 goto done;
1176 }
1177 }
1178
Feng Tang2b9603a2010-08-02 15:52:15 +08001179 mutex_lock(&board_lock);
1180 list_add_tail(&master->list, &spi_master_list);
1181 list_for_each_entry(bi, &board_list, list)
1182 spi_match_master_to_boardinfo(master, &bi->board_info);
1183 mutex_unlock(&board_lock);
1184
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001185 /* Register devices from the device tree and ACPI */
Anatolij Gustschin12b15e82010-07-27 22:35:58 +02001186 of_register_spi_devices(master);
Mika Westerberg64bee4d2012-11-30 12:37:53 +01001187 acpi_register_spi_devices(master);
David Brownell8ae12a02006-01-08 13:34:19 -08001188done:
1189 return status;
1190}
1191EXPORT_SYMBOL_GPL(spi_register_master);
1192
David Lamparter34860082010-08-30 23:54:17 +02001193static int __unregister(struct device *dev, void *null)
David Brownell8ae12a02006-01-08 13:34:19 -08001194{
David Lamparter34860082010-08-30 23:54:17 +02001195 spi_unregister_device(to_spi_device(dev));
David Brownell8ae12a02006-01-08 13:34:19 -08001196 return 0;
1197}
1198
1199/**
1200 * spi_unregister_master - unregister SPI master controller
1201 * @master: the master being unregistered
David Brownell33e34dc2007-05-08 00:32:21 -07001202 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001203 *
1204 * This call is used only by SPI master controller drivers, which are the
1205 * only ones directly touching chip registers.
1206 *
1207 * This must be called from context that can sleep.
1208 */
1209void spi_unregister_master(struct spi_master *master)
1210{
Jeff Garzik89fc9a12006-12-06 20:35:35 -08001211 int dummy;
1212
Linus Walleijffbbdd212012-02-22 10:05:38 +01001213 if (master->queued) {
1214 if (spi_destroy_queue(master))
1215 dev_err(&master->dev, "queue remove failed\n");
1216 }
1217
Feng Tang2b9603a2010-08-02 15:52:15 +08001218 mutex_lock(&board_lock);
1219 list_del(&master->list);
1220 mutex_unlock(&board_lock);
1221
Sebastian Andrzej Siewior97dbf372010-12-21 17:24:31 -08001222 dummy = device_for_each_child(&master->dev, NULL, __unregister);
Tony Jones49dce682007-10-16 01:27:48 -07001223 device_unregister(&master->dev);
David Brownell8ae12a02006-01-08 13:34:19 -08001224}
1225EXPORT_SYMBOL_GPL(spi_unregister_master);
1226
Linus Walleijffbbdd212012-02-22 10:05:38 +01001227int spi_master_suspend(struct spi_master *master)
1228{
1229 int ret;
1230
1231 /* Basically no-ops for non-queued masters */
1232 if (!master->queued)
1233 return 0;
1234
1235 ret = spi_stop_queue(master);
1236 if (ret)
1237 dev_err(&master->dev, "queue stop failed\n");
1238
1239 return ret;
1240}
1241EXPORT_SYMBOL_GPL(spi_master_suspend);
1242
1243int spi_master_resume(struct spi_master *master)
1244{
1245 int ret;
1246
1247 if (!master->queued)
1248 return 0;
1249
1250 ret = spi_start_queue(master);
1251 if (ret)
1252 dev_err(&master->dev, "queue restart failed\n");
1253
1254 return ret;
1255}
1256EXPORT_SYMBOL_GPL(spi_master_resume);
1257
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001258static int __spi_master_match(struct device *dev, const void *data)
Dave Young5ed2c832008-01-22 15:14:18 +08001259{
1260 struct spi_master *m;
Michał Mirosław9f3b7952013-02-01 20:40:17 +01001261 const u16 *bus_num = data;
Dave Young5ed2c832008-01-22 15:14:18 +08001262
1263 m = container_of(dev, struct spi_master, dev);
1264 return m->bus_num == *bus_num;
1265}
1266
David Brownell8ae12a02006-01-08 13:34:19 -08001267/**
1268 * spi_busnum_to_master - look up master associated with bus_num
1269 * @bus_num: the master's bus number
David Brownell33e34dc2007-05-08 00:32:21 -07001270 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001271 *
1272 * This call may be used with devices that are registered after
1273 * arch init time. It returns a refcounted pointer to the relevant
1274 * spi_master (which the caller must release), or NULL if there is
1275 * no such master registered.
1276 */
1277struct spi_master *spi_busnum_to_master(u16 bus_num)
1278{
Tony Jones49dce682007-10-16 01:27:48 -07001279 struct device *dev;
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -08001280 struct spi_master *master = NULL;
David Brownell8ae12a02006-01-08 13:34:19 -08001281
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04001282 dev = class_find_device(&spi_master_class, NULL, &bus_num,
Dave Young5ed2c832008-01-22 15:14:18 +08001283 __spi_master_match);
1284 if (dev)
1285 master = container_of(dev, struct spi_master, dev);
1286 /* reference got in class_find_device */
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -08001287 return master;
David Brownell8ae12a02006-01-08 13:34:19 -08001288}
1289EXPORT_SYMBOL_GPL(spi_busnum_to_master);
1290
1291
1292/*-------------------------------------------------------------------------*/
1293
David Brownell7d077192009-06-17 16:26:03 -07001294/* Core methods for SPI master protocol drivers. Some of the
1295 * other core methods are currently defined as inline functions.
1296 */
1297
1298/**
1299 * spi_setup - setup SPI mode and clock rate
1300 * @spi: the device whose settings are being modified
1301 * Context: can sleep, and no requests are queued to the device
1302 *
1303 * SPI protocol drivers may need to update the transfer mode if the
1304 * device doesn't work with its default. They may likewise need
1305 * to update clock rates or word sizes from initial values. This function
1306 * changes those settings, and must be called from a context that can sleep.
1307 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
1308 * effect the next time the device is selected and data is transferred to
1309 * or from it. When this function returns, the spi device is deselected.
1310 *
1311 * Note that this call will fail if the protocol driver specifies an option
1312 * that the underlying controller or its driver does not support. For
1313 * example, not all hardware supports wire transfers using nine bit words,
1314 * LSB-first wire encoding, or active-high chipselects.
1315 */
1316int spi_setup(struct spi_device *spi)
1317{
David Brownelle7db06b2009-06-17 16:26:04 -07001318 unsigned bad_bits;
Laxman Dewangancaae0702012-11-09 14:35:22 +05301319 int status = 0;
David Brownell7d077192009-06-17 16:26:03 -07001320
David Brownelle7db06b2009-06-17 16:26:04 -07001321 /* help drivers fail *cleanly* when they need options
1322 * that aren't supported with their current master
1323 */
1324 bad_bits = spi->mode & ~spi->master->mode_bits;
1325 if (bad_bits) {
Linus Walleijeb288a12010-10-21 21:06:44 +02001326 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
David Brownelle7db06b2009-06-17 16:26:04 -07001327 bad_bits);
1328 return -EINVAL;
1329 }
1330
David Brownell7d077192009-06-17 16:26:03 -07001331 if (!spi->bits_per_word)
1332 spi->bits_per_word = 8;
1333
Laxman Dewangancaae0702012-11-09 14:35:22 +05301334 if (spi->master->setup)
1335 status = spi->master->setup(spi);
David Brownell7d077192009-06-17 16:26:03 -07001336
1337 dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s"
1338 "%u bits/w, %u Hz max --> %d\n",
1339 (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
1340 (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
1341 (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
1342 (spi->mode & SPI_3WIRE) ? "3wire, " : "",
1343 (spi->mode & SPI_LOOP) ? "loopback, " : "",
1344 spi->bits_per_word, spi->max_speed_hz,
1345 status);
1346
1347 return status;
1348}
1349EXPORT_SYMBOL_GPL(spi_setup);
1350
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001351static int __spi_async(struct spi_device *spi, struct spi_message *message)
1352{
1353 struct spi_master *master = spi->master;
Laxman Dewangane6811d12012-11-09 14:36:45 +05301354 struct spi_transfer *xfer;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001355
1356 /* Half-duplex links include original MicroWire, and ones with
1357 * only one data pin like SPI_3WIRE (switches direction) or where
1358 * either MOSI or MISO is missing. They can also be caused by
1359 * software limitations.
1360 */
1361 if ((master->flags & SPI_MASTER_HALF_DUPLEX)
1362 || (spi->mode & SPI_3WIRE)) {
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001363 unsigned flags = master->flags;
1364
1365 list_for_each_entry(xfer, &message->transfers, transfer_list) {
1366 if (xfer->rx_buf && xfer->tx_buf)
1367 return -EINVAL;
1368 if ((flags & SPI_MASTER_NO_TX) && xfer->tx_buf)
1369 return -EINVAL;
1370 if ((flags & SPI_MASTER_NO_RX) && xfer->rx_buf)
1371 return -EINVAL;
1372 }
1373 }
1374
Laxman Dewangane6811d12012-11-09 14:36:45 +05301375 /**
Laxman Dewangan059b8ff2013-01-05 00:17:14 +05301376 * Set transfer bits_per_word and max speed as spi device default if
1377 * it is not set for this transfer.
Laxman Dewangane6811d12012-11-09 14:36:45 +05301378 */
1379 list_for_each_entry(xfer, &message->transfers, transfer_list) {
1380 if (!xfer->bits_per_word)
1381 xfer->bits_per_word = spi->bits_per_word;
Laxman Dewangan059b8ff2013-01-05 00:17:14 +05301382 if (!xfer->speed_hz)
1383 xfer->speed_hz = spi->max_speed_hz;
Stephen Warren543bb252013-03-26 20:37:57 -06001384 if (master->bits_per_word_mask) {
1385 /* Only 32 bits fit in the mask */
1386 if (xfer->bits_per_word > 32)
1387 return -EINVAL;
1388 if (!(master->bits_per_word_mask &
1389 BIT(xfer->bits_per_word - 1)))
1390 return -EINVAL;
1391 }
Laxman Dewangane6811d12012-11-09 14:36:45 +05301392 }
1393
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001394 message->spi = spi;
1395 message->status = -EINPROGRESS;
1396 return master->transfer(spi, message);
1397}
1398
David Brownell568d0692009-09-22 16:46:18 -07001399/**
1400 * spi_async - asynchronous SPI transfer
1401 * @spi: device with which data will be exchanged
1402 * @message: describes the data transfers, including completion callback
1403 * Context: any (irqs may be blocked, etc)
1404 *
1405 * This call may be used in_irq and other contexts which can't sleep,
1406 * as well as from task contexts which can sleep.
1407 *
1408 * The completion callback is invoked in a context which can't sleep.
1409 * Before that invocation, the value of message->status is undefined.
1410 * When the callback is issued, message->status holds either zero (to
1411 * indicate complete success) or a negative error code. After that
1412 * callback returns, the driver which issued the transfer request may
1413 * deallocate the associated memory; it's no longer in use by any SPI
1414 * core or controller driver code.
1415 *
1416 * Note that although all messages to a spi_device are handled in
1417 * FIFO order, messages may go to different devices in other orders.
1418 * Some device might be higher priority, or have various "hard" access
1419 * time requirements, for example.
1420 *
1421 * On detection of any fault during the transfer, processing of
1422 * the entire message is aborted, and the device is deselected.
1423 * Until returning from the associated message completion callback,
1424 * no other spi_message queued to that device will be processed.
1425 * (This rule applies equally to all the synchronous transfer calls,
1426 * which are wrappers around this core asynchronous primitive.)
1427 */
1428int spi_async(struct spi_device *spi, struct spi_message *message)
1429{
1430 struct spi_master *master = spi->master;
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001431 int ret;
1432 unsigned long flags;
David Brownell568d0692009-09-22 16:46:18 -07001433
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001434 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
David Brownell568d0692009-09-22 16:46:18 -07001435
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001436 if (master->bus_lock_flag)
1437 ret = -EBUSY;
1438 else
1439 ret = __spi_async(spi, message);
David Brownell568d0692009-09-22 16:46:18 -07001440
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001441 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
1442
1443 return ret;
David Brownell568d0692009-09-22 16:46:18 -07001444}
1445EXPORT_SYMBOL_GPL(spi_async);
1446
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001447/**
1448 * spi_async_locked - version of spi_async with exclusive bus usage
1449 * @spi: device with which data will be exchanged
1450 * @message: describes the data transfers, including completion callback
1451 * Context: any (irqs may be blocked, etc)
1452 *
1453 * This call may be used in_irq and other contexts which can't sleep,
1454 * as well as from task contexts which can sleep.
1455 *
1456 * The completion callback is invoked in a context which can't sleep.
1457 * Before that invocation, the value of message->status is undefined.
1458 * When the callback is issued, message->status holds either zero (to
1459 * indicate complete success) or a negative error code. After that
1460 * callback returns, the driver which issued the transfer request may
1461 * deallocate the associated memory; it's no longer in use by any SPI
1462 * core or controller driver code.
1463 *
1464 * Note that although all messages to a spi_device are handled in
1465 * FIFO order, messages may go to different devices in other orders.
1466 * Some device might be higher priority, or have various "hard" access
1467 * time requirements, for example.
1468 *
1469 * On detection of any fault during the transfer, processing of
1470 * the entire message is aborted, and the device is deselected.
1471 * Until returning from the associated message completion callback,
1472 * no other spi_message queued to that device will be processed.
1473 * (This rule applies equally to all the synchronous transfer calls,
1474 * which are wrappers around this core asynchronous primitive.)
1475 */
1476int spi_async_locked(struct spi_device *spi, struct spi_message *message)
1477{
1478 struct spi_master *master = spi->master;
1479 int ret;
1480 unsigned long flags;
1481
1482 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
1483
1484 ret = __spi_async(spi, message);
1485
1486 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
1487
1488 return ret;
1489
1490}
1491EXPORT_SYMBOL_GPL(spi_async_locked);
1492
David Brownell7d077192009-06-17 16:26:03 -07001493
1494/*-------------------------------------------------------------------------*/
1495
1496/* Utility methods for SPI master protocol drivers, layered on
1497 * top of the core. Some other utility methods are defined as
1498 * inline functions.
1499 */
1500
Andrew Morton5d870c82006-01-11 11:23:49 -08001501static void spi_complete(void *arg)
1502{
1503 complete(arg);
1504}
1505
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001506static int __spi_sync(struct spi_device *spi, struct spi_message *message,
1507 int bus_locked)
1508{
1509 DECLARE_COMPLETION_ONSTACK(done);
1510 int status;
1511 struct spi_master *master = spi->master;
1512
1513 message->complete = spi_complete;
1514 message->context = &done;
1515
1516 if (!bus_locked)
1517 mutex_lock(&master->bus_lock_mutex);
1518
1519 status = spi_async_locked(spi, message);
1520
1521 if (!bus_locked)
1522 mutex_unlock(&master->bus_lock_mutex);
1523
1524 if (status == 0) {
1525 wait_for_completion(&done);
1526 status = message->status;
1527 }
1528 message->context = NULL;
1529 return status;
1530}
1531
David Brownell8ae12a02006-01-08 13:34:19 -08001532/**
1533 * spi_sync - blocking/synchronous SPI data transfers
1534 * @spi: device with which data will be exchanged
1535 * @message: describes the data transfers
David Brownell33e34dc2007-05-08 00:32:21 -07001536 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001537 *
1538 * This call may only be used from a context that may sleep. The sleep
1539 * is non-interruptible, and has no timeout. Low-overhead controller
1540 * drivers may DMA directly into and out of the message buffers.
1541 *
1542 * Note that the SPI device's chip select is active during the message,
1543 * and then is normally disabled between messages. Drivers for some
1544 * frequently-used devices may want to minimize costs of selecting a chip,
1545 * by leaving it selected in anticipation that the next message will go
1546 * to the same chip. (That may increase power usage.)
1547 *
David Brownell0c868462006-01-08 13:34:25 -08001548 * Also, the caller is guaranteeing that the memory associated with the
1549 * message will not be freed before this call returns.
1550 *
Marc Pignat9b938b72007-12-04 23:45:10 -08001551 * It returns zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -08001552 */
1553int spi_sync(struct spi_device *spi, struct spi_message *message)
1554{
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001555 return __spi_sync(spi, message, 0);
David Brownell8ae12a02006-01-08 13:34:19 -08001556}
1557EXPORT_SYMBOL_GPL(spi_sync);
1558
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001559/**
1560 * spi_sync_locked - version of spi_sync with exclusive bus usage
1561 * @spi: device with which data will be exchanged
1562 * @message: describes the data transfers
1563 * Context: can sleep
1564 *
1565 * This call may only be used from a context that may sleep. The sleep
1566 * is non-interruptible, and has no timeout. Low-overhead controller
1567 * drivers may DMA directly into and out of the message buffers.
1568 *
1569 * This call should be used by drivers that require exclusive access to the
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001570 * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
Ernst Schwabcf32b71e2010-06-28 17:49:29 -07001571 * be released by a spi_bus_unlock call when the exclusive access is over.
1572 *
1573 * It returns zero on success, else a negative error code.
1574 */
1575int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
1576{
1577 return __spi_sync(spi, message, 1);
1578}
1579EXPORT_SYMBOL_GPL(spi_sync_locked);
1580
1581/**
1582 * spi_bus_lock - obtain a lock for exclusive SPI bus usage
1583 * @master: SPI bus master that should be locked for exclusive bus access
1584 * Context: can sleep
1585 *
1586 * This call may only be used from a context that may sleep. The sleep
1587 * is non-interruptible, and has no timeout.
1588 *
1589 * This call should be used by drivers that require exclusive access to the
1590 * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
1591 * exclusive access is over. Data transfer must be done by spi_sync_locked
1592 * and spi_async_locked calls when the SPI bus lock is held.
1593 *
1594 * It returns zero on success, else a negative error code.
1595 */
1596int spi_bus_lock(struct spi_master *master)
1597{
1598 unsigned long flags;
1599
1600 mutex_lock(&master->bus_lock_mutex);
1601
1602 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
1603 master->bus_lock_flag = 1;
1604 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
1605
1606 /* mutex remains locked until spi_bus_unlock is called */
1607
1608 return 0;
1609}
1610EXPORT_SYMBOL_GPL(spi_bus_lock);
1611
1612/**
1613 * spi_bus_unlock - release the lock for exclusive SPI bus usage
1614 * @master: SPI bus master that was locked for exclusive bus access
1615 * Context: can sleep
1616 *
1617 * This call may only be used from a context that may sleep. The sleep
1618 * is non-interruptible, and has no timeout.
1619 *
1620 * This call releases an SPI bus lock previously obtained by an spi_bus_lock
1621 * call.
1622 *
1623 * It returns zero on success, else a negative error code.
1624 */
1625int spi_bus_unlock(struct spi_master *master)
1626{
1627 master->bus_lock_flag = 0;
1628
1629 mutex_unlock(&master->bus_lock_mutex);
1630
1631 return 0;
1632}
1633EXPORT_SYMBOL_GPL(spi_bus_unlock);
1634
David Brownella9948b62006-04-02 10:37:40 -08001635/* portable code must never pass more than 32 bytes */
1636#define SPI_BUFSIZ max(32,SMP_CACHE_BYTES)
David Brownell8ae12a02006-01-08 13:34:19 -08001637
1638static u8 *buf;
1639
1640/**
1641 * spi_write_then_read - SPI synchronous write followed by read
1642 * @spi: device with which data will be exchanged
1643 * @txbuf: data to be written (need not be dma-safe)
1644 * @n_tx: size of txbuf, in bytes
Jiri Pirko27570492009-06-17 16:26:06 -07001645 * @rxbuf: buffer into which data will be read (need not be dma-safe)
1646 * @n_rx: size of rxbuf, in bytes
David Brownell33e34dc2007-05-08 00:32:21 -07001647 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -08001648 *
1649 * This performs a half duplex MicroWire style transaction with the
1650 * device, sending txbuf and then reading rxbuf. The return value
1651 * is zero for success, else a negative errno status code.
David Brownellb8852442006-01-08 13:34:23 -08001652 * This call may only be used from a context that may sleep.
David Brownell8ae12a02006-01-08 13:34:19 -08001653 *
David Brownell0c868462006-01-08 13:34:25 -08001654 * Parameters to this routine are always copied using a small buffer;
David Brownell33e34dc2007-05-08 00:32:21 -07001655 * portable code should never use this for more than 32 bytes.
1656 * Performance-sensitive or bulk transfer code should instead use
David Brownell0c868462006-01-08 13:34:25 -08001657 * spi_{async,sync}() calls with dma-safe buffers.
David Brownell8ae12a02006-01-08 13:34:19 -08001658 */
1659int spi_write_then_read(struct spi_device *spi,
Mark Brown0c4a1592011-05-11 00:09:30 +02001660 const void *txbuf, unsigned n_tx,
1661 void *rxbuf, unsigned n_rx)
David Brownell8ae12a02006-01-08 13:34:19 -08001662{
David Brownell068f4072007-12-04 23:45:09 -08001663 static DEFINE_MUTEX(lock);
David Brownell8ae12a02006-01-08 13:34:19 -08001664
1665 int status;
1666 struct spi_message message;
David Brownellbdff5492009-04-13 14:39:57 -07001667 struct spi_transfer x[2];
David Brownell8ae12a02006-01-08 13:34:19 -08001668 u8 *local_buf;
1669
Mark Brownb3a223e2012-12-02 12:54:25 +09001670 /* Use preallocated DMA-safe buffer if we can. We can't avoid
1671 * copying here, (as a pure convenience thing), but we can
1672 * keep heap costs out of the hot path unless someone else is
1673 * using the pre-allocated buffer or the transfer is too large.
David Brownell8ae12a02006-01-08 13:34:19 -08001674 */
Mark Brownb3a223e2012-12-02 12:54:25 +09001675 if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
Mark Brown2cd94c82013-01-27 14:35:04 +08001676 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
1677 GFP_KERNEL | GFP_DMA);
Mark Brownb3a223e2012-12-02 12:54:25 +09001678 if (!local_buf)
1679 return -ENOMEM;
1680 } else {
1681 local_buf = buf;
1682 }
David Brownell8ae12a02006-01-08 13:34:19 -08001683
Vitaly Wool8275c642006-01-08 13:34:28 -08001684 spi_message_init(&message);
David Brownellbdff5492009-04-13 14:39:57 -07001685 memset(x, 0, sizeof x);
1686 if (n_tx) {
1687 x[0].len = n_tx;
1688 spi_message_add_tail(&x[0], &message);
1689 }
1690 if (n_rx) {
1691 x[1].len = n_rx;
1692 spi_message_add_tail(&x[1], &message);
1693 }
Vitaly Wool8275c642006-01-08 13:34:28 -08001694
David Brownell8ae12a02006-01-08 13:34:19 -08001695 memcpy(local_buf, txbuf, n_tx);
David Brownellbdff5492009-04-13 14:39:57 -07001696 x[0].tx_buf = local_buf;
1697 x[1].rx_buf = local_buf + n_tx;
David Brownell8ae12a02006-01-08 13:34:19 -08001698
1699 /* do the i/o */
David Brownell8ae12a02006-01-08 13:34:19 -08001700 status = spi_sync(spi, &message);
Marc Pignat9b938b72007-12-04 23:45:10 -08001701 if (status == 0)
David Brownellbdff5492009-04-13 14:39:57 -07001702 memcpy(rxbuf, x[1].rx_buf, n_rx);
David Brownell8ae12a02006-01-08 13:34:19 -08001703
David Brownellbdff5492009-04-13 14:39:57 -07001704 if (x[0].tx_buf == buf)
David Brownell068f4072007-12-04 23:45:09 -08001705 mutex_unlock(&lock);
David Brownell8ae12a02006-01-08 13:34:19 -08001706 else
1707 kfree(local_buf);
1708
1709 return status;
1710}
1711EXPORT_SYMBOL_GPL(spi_write_then_read);
1712
1713/*-------------------------------------------------------------------------*/
1714
1715static int __init spi_init(void)
1716{
David Brownellb8852442006-01-08 13:34:23 -08001717 int status;
David Brownell8ae12a02006-01-08 13:34:19 -08001718
Christoph Lametere94b1762006-12-06 20:33:17 -08001719 buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
David Brownellb8852442006-01-08 13:34:23 -08001720 if (!buf) {
1721 status = -ENOMEM;
1722 goto err0;
1723 }
1724
1725 status = bus_register(&spi_bus_type);
1726 if (status < 0)
1727 goto err1;
1728
1729 status = class_register(&spi_master_class);
1730 if (status < 0)
1731 goto err2;
David Brownell8ae12a02006-01-08 13:34:19 -08001732 return 0;
David Brownellb8852442006-01-08 13:34:23 -08001733
1734err2:
1735 bus_unregister(&spi_bus_type);
1736err1:
1737 kfree(buf);
1738 buf = NULL;
1739err0:
1740 return status;
David Brownell8ae12a02006-01-08 13:34:19 -08001741}
David Brownellb8852442006-01-08 13:34:23 -08001742
David Brownell8ae12a02006-01-08 13:34:19 -08001743/* board_info is normally registered in arch_initcall(),
1744 * but even essential drivers wait till later
David Brownellb8852442006-01-08 13:34:23 -08001745 *
1746 * REVISIT only boardinfo really needs static linking. the rest (device and
1747 * driver registration) _could_ be dynamically linked (modular) ... costs
1748 * include needing to have boardinfo data structures be much more public.
David Brownell8ae12a02006-01-08 13:34:19 -08001749 */
David Brownell673c0c02008-10-15 22:02:46 -07001750postcore_initcall(spi_init);
David Brownell8ae12a02006-01-08 13:34:19 -08001751