blob: 8518a6eb63f32c9ba932d40e9118dcefcc908eb5 [file] [log] [blame]
David Brownell8ae12a02006-01-08 13:34:19 -08001/*
2 * spi.c - SPI init/core code
3 *
4 * Copyright (C) 2005 David Brownell
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
David Brownell8ae12a02006-01-08 13:34:19 -080021#include <linux/kernel.h>
22#include <linux/device.h>
23#include <linux/init.h>
24#include <linux/cache.h>
Matthias Kaehlcke94040822007-07-17 04:04:16 -070025#include <linux/mutex.h>
David Brownell8ae12a02006-01-08 13:34:19 -080026#include <linux/spi/spi.h>
27
28
David Brownellb8852442006-01-08 13:34:23 -080029/* SPI bustype and spi_master class are registered after board init code
30 * provides the SPI device tables, ensuring that both are present by the
31 * time controller driver registration causes spi_devices to "enumerate".
David Brownell8ae12a02006-01-08 13:34:19 -080032 */
33static void spidev_release(struct device *dev)
34{
Hans-Peter Nilsson0ffa0282007-02-12 00:52:45 -080035 struct spi_device *spi = to_spi_device(dev);
David Brownell8ae12a02006-01-08 13:34:19 -080036
37 /* spi masters may cleanup for released devices */
38 if (spi->master->cleanup)
39 spi->master->cleanup(spi);
40
David Brownell0c868462006-01-08 13:34:25 -080041 spi_master_put(spi->master);
David Brownell8ae12a02006-01-08 13:34:19 -080042 kfree(dev);
43}
44
45static ssize_t
46modalias_show(struct device *dev, struct device_attribute *a, char *buf)
47{
48 const struct spi_device *spi = to_spi_device(dev);
49
Kay Sievers35f74fc2009-01-06 10:44:37 -080050 return sprintf(buf, "%s\n", spi->modalias);
David Brownell8ae12a02006-01-08 13:34:19 -080051}
52
53static struct device_attribute spi_dev_attrs[] = {
54 __ATTR_RO(modalias),
55 __ATTR_NULL,
56};
57
58/* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
59 * and the sysfs version makes coldplug work too.
60 */
61
Anton Vorontsov75368bf2009-09-22 16:46:04 -070062static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
63 const struct spi_device *sdev)
64{
65 while (id->name[0]) {
66 if (!strcmp(sdev->modalias, id->name))
67 return id;
68 id++;
69 }
70 return NULL;
71}
72
73const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
74{
75 const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
76
77 return spi_match_id(sdrv->id_table, sdev);
78}
79EXPORT_SYMBOL_GPL(spi_get_device_id);
80
David Brownell8ae12a02006-01-08 13:34:19 -080081static int spi_match_device(struct device *dev, struct device_driver *drv)
82{
83 const struct spi_device *spi = to_spi_device(dev);
Anton Vorontsov75368bf2009-09-22 16:46:04 -070084 const struct spi_driver *sdrv = to_spi_driver(drv);
85
86 if (sdrv->id_table)
87 return !!spi_match_id(sdrv->id_table, spi);
David Brownell8ae12a02006-01-08 13:34:19 -080088
Kay Sievers35f74fc2009-01-06 10:44:37 -080089 return strcmp(spi->modalias, drv->name) == 0;
David Brownell8ae12a02006-01-08 13:34:19 -080090}
91
Kay Sievers7eff2e72007-08-14 15:15:12 +020092static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
David Brownell8ae12a02006-01-08 13:34:19 -080093{
94 const struct spi_device *spi = to_spi_device(dev);
95
Kay Sievers7eff2e72007-08-14 15:15:12 +020096 add_uevent_var(env, "MODALIAS=%s", spi->modalias);
David Brownell8ae12a02006-01-08 13:34:19 -080097 return 0;
98}
99
100#ifdef CONFIG_PM
101
David Brownell8ae12a02006-01-08 13:34:19 -0800102static int spi_suspend(struct device *dev, pm_message_t message)
103{
David Brownell3c724262008-02-06 01:38:10 -0800104 int value = 0;
David Brownellb8852442006-01-08 13:34:23 -0800105 struct spi_driver *drv = to_spi_driver(dev->driver);
David Brownell8ae12a02006-01-08 13:34:19 -0800106
David Brownell8ae12a02006-01-08 13:34:19 -0800107 /* suspend will stop irqs and dma; no more i/o */
David Brownell3c724262008-02-06 01:38:10 -0800108 if (drv) {
109 if (drv->suspend)
110 value = drv->suspend(to_spi_device(dev), message);
111 else
112 dev_dbg(dev, "... can't suspend\n");
113 }
David Brownell8ae12a02006-01-08 13:34:19 -0800114 return value;
115}
116
117static int spi_resume(struct device *dev)
118{
David Brownell3c724262008-02-06 01:38:10 -0800119 int value = 0;
David Brownellb8852442006-01-08 13:34:23 -0800120 struct spi_driver *drv = to_spi_driver(dev->driver);
David Brownell8ae12a02006-01-08 13:34:19 -0800121
David Brownell8ae12a02006-01-08 13:34:19 -0800122 /* resume may restart the i/o queue */
David Brownell3c724262008-02-06 01:38:10 -0800123 if (drv) {
124 if (drv->resume)
125 value = drv->resume(to_spi_device(dev));
126 else
127 dev_dbg(dev, "... can't resume\n");
128 }
David Brownell8ae12a02006-01-08 13:34:19 -0800129 return value;
130}
131
132#else
133#define spi_suspend NULL
134#define spi_resume NULL
135#endif
136
137struct bus_type spi_bus_type = {
138 .name = "spi",
139 .dev_attrs = spi_dev_attrs,
140 .match = spi_match_device,
141 .uevent = spi_uevent,
142 .suspend = spi_suspend,
143 .resume = spi_resume,
144};
145EXPORT_SYMBOL_GPL(spi_bus_type);
146
David Brownellb8852442006-01-08 13:34:23 -0800147
148static int spi_drv_probe(struct device *dev)
149{
150 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
151
152 return sdrv->probe(to_spi_device(dev));
153}
154
155static int spi_drv_remove(struct device *dev)
156{
157 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
158
159 return sdrv->remove(to_spi_device(dev));
160}
161
162static void spi_drv_shutdown(struct device *dev)
163{
164 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
165
166 sdrv->shutdown(to_spi_device(dev));
167}
168
David Brownell33e34dc2007-05-08 00:32:21 -0700169/**
170 * spi_register_driver - register a SPI driver
171 * @sdrv: the driver to register
172 * Context: can sleep
173 */
David Brownellb8852442006-01-08 13:34:23 -0800174int spi_register_driver(struct spi_driver *sdrv)
175{
176 sdrv->driver.bus = &spi_bus_type;
177 if (sdrv->probe)
178 sdrv->driver.probe = spi_drv_probe;
179 if (sdrv->remove)
180 sdrv->driver.remove = spi_drv_remove;
181 if (sdrv->shutdown)
182 sdrv->driver.shutdown = spi_drv_shutdown;
183 return driver_register(&sdrv->driver);
184}
185EXPORT_SYMBOL_GPL(spi_register_driver);
186
David Brownell8ae12a02006-01-08 13:34:19 -0800187/*-------------------------------------------------------------------------*/
188
189/* SPI devices should normally not be created by SPI device drivers; that
190 * would make them board-specific. Similarly with SPI master drivers.
191 * Device registration normally goes into like arch/.../mach.../board-YYY.c
192 * with other readonly (flashable) information about mainboard devices.
193 */
194
195struct boardinfo {
196 struct list_head list;
197 unsigned n_board_info;
198 struct spi_board_info board_info[0];
199};
200
201static LIST_HEAD(board_list);
Matthias Kaehlcke94040822007-07-17 04:04:16 -0700202static DEFINE_MUTEX(board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800203
Grant Likelydc87c982008-05-15 16:50:22 -0600204/**
205 * spi_alloc_device - Allocate a new SPI device
206 * @master: Controller to which device is connected
207 * Context: can sleep
208 *
209 * Allows a driver to allocate and initialize a spi_device without
210 * registering it immediately. This allows a driver to directly
211 * fill the spi_device with device parameters before calling
212 * spi_add_device() on it.
213 *
214 * Caller is responsible to call spi_add_device() on the returned
215 * spi_device structure to add it to the SPI master. If the caller
216 * needs to discard the spi_device without adding it, then it should
217 * call spi_dev_put() on it.
218 *
219 * Returns a pointer to the new device, or NULL.
220 */
221struct spi_device *spi_alloc_device(struct spi_master *master)
222{
223 struct spi_device *spi;
224 struct device *dev = master->dev.parent;
225
226 if (!spi_master_get(master))
227 return NULL;
228
229 spi = kzalloc(sizeof *spi, GFP_KERNEL);
230 if (!spi) {
231 dev_err(dev, "cannot alloc spi_device\n");
232 spi_master_put(master);
233 return NULL;
234 }
235
236 spi->master = master;
237 spi->dev.parent = dev;
238 spi->dev.bus = &spi_bus_type;
239 spi->dev.release = spidev_release;
240 device_initialize(&spi->dev);
241 return spi;
242}
243EXPORT_SYMBOL_GPL(spi_alloc_device);
244
245/**
246 * spi_add_device - Add spi_device allocated with spi_alloc_device
247 * @spi: spi_device to register
248 *
249 * Companion function to spi_alloc_device. Devices allocated with
250 * spi_alloc_device can be added onto the spi bus with this function.
251 *
David Brownelle48880e2008-08-15 00:40:44 -0700252 * Returns 0 on success; negative errno on failure
Grant Likelydc87c982008-05-15 16:50:22 -0600253 */
254int spi_add_device(struct spi_device *spi)
255{
David Brownelle48880e2008-08-15 00:40:44 -0700256 static DEFINE_MUTEX(spi_add_lock);
Grant Likelydc87c982008-05-15 16:50:22 -0600257 struct device *dev = spi->master->dev.parent;
258 int status;
259
260 /* Chipselects are numbered 0..max; validate. */
261 if (spi->chip_select >= spi->master->num_chipselect) {
262 dev_err(dev, "cs%d >= max %d\n",
263 spi->chip_select,
264 spi->master->num_chipselect);
265 return -EINVAL;
266 }
267
268 /* Set the bus ID string */
Kay Sievers35f74fc2009-01-06 10:44:37 -0800269 dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
Grant Likelydc87c982008-05-15 16:50:22 -0600270 spi->chip_select);
271
David Brownelle48880e2008-08-15 00:40:44 -0700272
273 /* We need to make sure there's no other device with this
274 * chipselect **BEFORE** we call setup(), else we'll trash
275 * its configuration. Lock against concurrent add() calls.
276 */
277 mutex_lock(&spi_add_lock);
278
Kay Sievers35f74fc2009-01-06 10:44:37 -0800279 if (bus_find_device_by_name(&spi_bus_type, NULL, dev_name(&spi->dev))
David Brownelle48880e2008-08-15 00:40:44 -0700280 != NULL) {
281 dev_err(dev, "chipselect %d already in use\n",
282 spi->chip_select);
283 status = -EBUSY;
284 goto done;
285 }
286
287 /* Drivers may modify this initial i/o setup, but will
288 * normally rely on the device being setup. Devices
289 * using SPI_CS_HIGH can't coexist well otherwise...
290 */
David Brownell7d077192009-06-17 16:26:03 -0700291 status = spi_setup(spi);
Grant Likelydc87c982008-05-15 16:50:22 -0600292 if (status < 0) {
293 dev_err(dev, "can't %s %s, status %d\n",
Kay Sievers35f74fc2009-01-06 10:44:37 -0800294 "setup", dev_name(&spi->dev), status);
David Brownelle48880e2008-08-15 00:40:44 -0700295 goto done;
Grant Likelydc87c982008-05-15 16:50:22 -0600296 }
297
David Brownelle48880e2008-08-15 00:40:44 -0700298 /* Device may be bound to an active driver when this returns */
Grant Likelydc87c982008-05-15 16:50:22 -0600299 status = device_add(&spi->dev);
David Brownelle48880e2008-08-15 00:40:44 -0700300 if (status < 0)
Grant Likelydc87c982008-05-15 16:50:22 -0600301 dev_err(dev, "can't %s %s, status %d\n",
Kay Sievers35f74fc2009-01-06 10:44:37 -0800302 "add", dev_name(&spi->dev), status);
David Brownelle48880e2008-08-15 00:40:44 -0700303 else
Kay Sievers35f74fc2009-01-06 10:44:37 -0800304 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
Grant Likelydc87c982008-05-15 16:50:22 -0600305
David Brownelle48880e2008-08-15 00:40:44 -0700306done:
307 mutex_unlock(&spi_add_lock);
308 return status;
Grant Likelydc87c982008-05-15 16:50:22 -0600309}
310EXPORT_SYMBOL_GPL(spi_add_device);
David Brownell8ae12a02006-01-08 13:34:19 -0800311
David Brownell33e34dc2007-05-08 00:32:21 -0700312/**
313 * spi_new_device - instantiate one new SPI device
314 * @master: Controller to which device is connected
315 * @chip: Describes the SPI device
316 * Context: can sleep
317 *
318 * On typical mainboards, this is purely internal; and it's not needed
David Brownell8ae12a02006-01-08 13:34:19 -0800319 * after board init creates the hard-wired devices. Some development
320 * platforms may not be able to use spi_register_board_info though, and
321 * this is exported so that for example a USB or parport based adapter
322 * driver could add devices (which it would learn about out-of-band).
David Brownell082c8cb2007-07-31 00:39:45 -0700323 *
324 * Returns the new device, or NULL.
David Brownell8ae12a02006-01-08 13:34:19 -0800325 */
Adrian Bunke9d5a462007-03-26 21:32:23 -0800326struct spi_device *spi_new_device(struct spi_master *master,
327 struct spi_board_info *chip)
David Brownell8ae12a02006-01-08 13:34:19 -0800328{
329 struct spi_device *proxy;
David Brownell8ae12a02006-01-08 13:34:19 -0800330 int status;
331
David Brownell082c8cb2007-07-31 00:39:45 -0700332 /* NOTE: caller did any chip->bus_num checks necessary.
333 *
334 * Also, unless we change the return value convention to use
335 * error-or-pointer (not NULL-or-pointer), troubleshootability
336 * suggests syslogged diagnostics are best here (ugh).
337 */
338
Grant Likelydc87c982008-05-15 16:50:22 -0600339 proxy = spi_alloc_device(master);
340 if (!proxy)
David Brownell8ae12a02006-01-08 13:34:19 -0800341 return NULL;
342
Grant Likely102eb972008-07-23 21:29:55 -0700343 WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
344
David Brownell8ae12a02006-01-08 13:34:19 -0800345 proxy->chip_select = chip->chip_select;
346 proxy->max_speed_hz = chip->max_speed_hz;
David Brownell980a01c2006-06-28 07:47:15 -0700347 proxy->mode = chip->mode;
David Brownell8ae12a02006-01-08 13:34:19 -0800348 proxy->irq = chip->irq;
Grant Likely102eb972008-07-23 21:29:55 -0700349 strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
David Brownell8ae12a02006-01-08 13:34:19 -0800350 proxy->dev.platform_data = (void *) chip->platform_data;
351 proxy->controller_data = chip->controller_data;
352 proxy->controller_state = NULL;
David Brownell8ae12a02006-01-08 13:34:19 -0800353
Grant Likelydc87c982008-05-15 16:50:22 -0600354 status = spi_add_device(proxy);
David Brownell8ae12a02006-01-08 13:34:19 -0800355 if (status < 0) {
Grant Likelydc87c982008-05-15 16:50:22 -0600356 spi_dev_put(proxy);
357 return NULL;
David Brownell8ae12a02006-01-08 13:34:19 -0800358 }
359
David Brownell8ae12a02006-01-08 13:34:19 -0800360 return proxy;
361}
362EXPORT_SYMBOL_GPL(spi_new_device);
363
David Brownell33e34dc2007-05-08 00:32:21 -0700364/**
365 * spi_register_board_info - register SPI devices for a given board
366 * @info: array of chip descriptors
367 * @n: how many descriptors are provided
368 * Context: can sleep
369 *
David Brownell8ae12a02006-01-08 13:34:19 -0800370 * Board-specific early init code calls this (probably during arch_initcall)
371 * with segments of the SPI device table. Any device nodes are created later,
372 * after the relevant parent SPI controller (bus_num) is defined. We keep
373 * this table of devices forever, so that reloading a controller driver will
374 * not make Linux forget about these hard-wired devices.
375 *
376 * Other code can also call this, e.g. a particular add-on board might provide
377 * SPI devices through its expansion connector, so code initializing that board
378 * would naturally declare its SPI devices.
379 *
380 * The board info passed can safely be __initdata ... but be careful of
381 * any embedded pointers (platform_data, etc), they're copied as-is.
382 */
383int __init
384spi_register_board_info(struct spi_board_info const *info, unsigned n)
385{
386 struct boardinfo *bi;
387
David Brownellb8852442006-01-08 13:34:23 -0800388 bi = kmalloc(sizeof(*bi) + n * sizeof *info, GFP_KERNEL);
David Brownell8ae12a02006-01-08 13:34:19 -0800389 if (!bi)
390 return -ENOMEM;
391 bi->n_board_info = n;
David Brownellb8852442006-01-08 13:34:23 -0800392 memcpy(bi->board_info, info, n * sizeof *info);
David Brownell8ae12a02006-01-08 13:34:19 -0800393
Matthias Kaehlcke94040822007-07-17 04:04:16 -0700394 mutex_lock(&board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800395 list_add_tail(&bi->list, &board_list);
Matthias Kaehlcke94040822007-07-17 04:04:16 -0700396 mutex_unlock(&board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800397 return 0;
398}
David Brownell8ae12a02006-01-08 13:34:19 -0800399
400/* FIXME someone should add support for a __setup("spi", ...) that
401 * creates board info from kernel command lines
402 */
403
Adrian Bunk149a6502007-07-21 04:37:52 -0700404static void scan_boardinfo(struct spi_master *master)
David Brownell8ae12a02006-01-08 13:34:19 -0800405{
406 struct boardinfo *bi;
David Brownell8ae12a02006-01-08 13:34:19 -0800407
Matthias Kaehlcke94040822007-07-17 04:04:16 -0700408 mutex_lock(&board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800409 list_for_each_entry(bi, &board_list, list) {
410 struct spi_board_info *chip = bi->board_info;
411 unsigned n;
412
413 for (n = bi->n_board_info; n > 0; n--, chip++) {
414 if (chip->bus_num != master->bus_num)
415 continue;
David Brownell082c8cb2007-07-31 00:39:45 -0700416 /* NOTE: this relies on spi_new_device to
417 * issue diagnostics when given bogus inputs
David Brownell8ae12a02006-01-08 13:34:19 -0800418 */
David Brownell8ae12a02006-01-08 13:34:19 -0800419 (void) spi_new_device(master, chip);
420 }
421 }
Matthias Kaehlcke94040822007-07-17 04:04:16 -0700422 mutex_unlock(&board_lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800423}
424
425/*-------------------------------------------------------------------------*/
426
Tony Jones49dce682007-10-16 01:27:48 -0700427static void spi_master_release(struct device *dev)
David Brownell8ae12a02006-01-08 13:34:19 -0800428{
429 struct spi_master *master;
430
Tony Jones49dce682007-10-16 01:27:48 -0700431 master = container_of(dev, struct spi_master, dev);
David Brownell8ae12a02006-01-08 13:34:19 -0800432 kfree(master);
433}
434
435static struct class spi_master_class = {
436 .name = "spi_master",
437 .owner = THIS_MODULE,
Tony Jones49dce682007-10-16 01:27:48 -0700438 .dev_release = spi_master_release,
David Brownell8ae12a02006-01-08 13:34:19 -0800439};
440
441
442/**
443 * spi_alloc_master - allocate SPI master controller
444 * @dev: the controller, possibly using the platform_bus
David Brownell33e34dc2007-05-08 00:32:21 -0700445 * @size: how much zeroed driver-private data to allocate; the pointer to this
Tony Jones49dce682007-10-16 01:27:48 -0700446 * memory is in the driver_data field of the returned device,
David Brownell0c868462006-01-08 13:34:25 -0800447 * accessible with spi_master_get_devdata().
David Brownell33e34dc2007-05-08 00:32:21 -0700448 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -0800449 *
450 * This call is used only by SPI master controller drivers, which are the
451 * only ones directly touching chip registers. It's how they allocate
dmitry pervushinba1a0512006-05-20 15:00:14 -0700452 * an spi_master structure, prior to calling spi_register_master().
David Brownell8ae12a02006-01-08 13:34:19 -0800453 *
454 * This must be called from context that can sleep. It returns the SPI
455 * master structure on success, else NULL.
456 *
457 * The caller is responsible for assigning the bus number and initializing
dmitry pervushinba1a0512006-05-20 15:00:14 -0700458 * the master's methods before calling spi_register_master(); and (after errors
David Brownell0c868462006-01-08 13:34:25 -0800459 * adding the device) calling spi_master_put() to prevent a memory leak.
David Brownell8ae12a02006-01-08 13:34:19 -0800460 */
Adrian Bunke9d5a462007-03-26 21:32:23 -0800461struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
David Brownell8ae12a02006-01-08 13:34:19 -0800462{
463 struct spi_master *master;
464
David Brownell0c868462006-01-08 13:34:25 -0800465 if (!dev)
466 return NULL;
467
Christoph Lametere94b1762006-12-06 20:33:17 -0800468 master = kzalloc(size + sizeof *master, GFP_KERNEL);
David Brownell8ae12a02006-01-08 13:34:19 -0800469 if (!master)
470 return NULL;
471
Tony Jones49dce682007-10-16 01:27:48 -0700472 device_initialize(&master->dev);
473 master->dev.class = &spi_master_class;
474 master->dev.parent = get_device(dev);
David Brownell0c868462006-01-08 13:34:25 -0800475 spi_master_set_devdata(master, &master[1]);
David Brownell8ae12a02006-01-08 13:34:19 -0800476
477 return master;
478}
479EXPORT_SYMBOL_GPL(spi_alloc_master);
480
481/**
482 * spi_register_master - register SPI master controller
483 * @master: initialized master, originally from spi_alloc_master()
David Brownell33e34dc2007-05-08 00:32:21 -0700484 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -0800485 *
486 * SPI master controllers connect to their drivers using some non-SPI bus,
487 * such as the platform bus. The final stage of probe() in that code
488 * includes calling spi_register_master() to hook up to this SPI bus glue.
489 *
490 * SPI controllers use board specific (often SOC specific) bus numbers,
491 * and board-specific addressing for SPI devices combines those numbers
492 * with chip select numbers. Since SPI does not directly support dynamic
493 * device identification, boards need configuration tables telling which
494 * chip is at which address.
495 *
496 * This must be called from context that can sleep. It returns zero on
497 * success, else a negative error code (dropping the master's refcount).
David Brownell0c868462006-01-08 13:34:25 -0800498 * After a successful return, the caller is responsible for calling
499 * spi_unregister_master().
David Brownell8ae12a02006-01-08 13:34:19 -0800500 */
Adrian Bunke9d5a462007-03-26 21:32:23 -0800501int spi_register_master(struct spi_master *master)
David Brownell8ae12a02006-01-08 13:34:19 -0800502{
David Brownelle44a45a2007-06-03 13:50:40 -0700503 static atomic_t dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
Tony Jones49dce682007-10-16 01:27:48 -0700504 struct device *dev = master->dev.parent;
David Brownell8ae12a02006-01-08 13:34:19 -0800505 int status = -ENODEV;
506 int dynamic = 0;
507
David Brownell0c868462006-01-08 13:34:25 -0800508 if (!dev)
509 return -ENODEV;
510
David Brownell082c8cb2007-07-31 00:39:45 -0700511 /* even if it's just one always-selected device, there must
512 * be at least one chipselect
513 */
514 if (master->num_chipselect == 0)
515 return -EINVAL;
516
David Brownell8ae12a02006-01-08 13:34:19 -0800517 /* convention: dynamically assigned bus IDs count down from the max */
David Brownella020ed72006-04-03 15:49:04 -0700518 if (master->bus_num < 0) {
David Brownell082c8cb2007-07-31 00:39:45 -0700519 /* FIXME switch to an IDR based scheme, something like
520 * I2C now uses, so we can't run out of "dynamic" IDs
521 */
David Brownell8ae12a02006-01-08 13:34:19 -0800522 master->bus_num = atomic_dec_return(&dyn_bus_id);
David Brownellb8852442006-01-08 13:34:23 -0800523 dynamic = 1;
David Brownell8ae12a02006-01-08 13:34:19 -0800524 }
525
526 /* register the device, then userspace will see it.
527 * registration fails if the bus ID is in use.
528 */
Kay Sievers35f74fc2009-01-06 10:44:37 -0800529 dev_set_name(&master->dev, "spi%u", master->bus_num);
Tony Jones49dce682007-10-16 01:27:48 -0700530 status = device_add(&master->dev);
David Brownellb8852442006-01-08 13:34:23 -0800531 if (status < 0)
David Brownell8ae12a02006-01-08 13:34:19 -0800532 goto done;
Kay Sievers35f74fc2009-01-06 10:44:37 -0800533 dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
David Brownell8ae12a02006-01-08 13:34:19 -0800534 dynamic ? " (dynamic)" : "");
535
536 /* populate children from any spi device tables */
537 scan_boardinfo(master);
538 status = 0;
539done:
540 return status;
541}
542EXPORT_SYMBOL_GPL(spi_register_master);
543
544
Atsushi Nemoto350d0072007-11-14 16:59:22 -0800545static int __unregister(struct device *dev, void *master_dev)
David Brownell8ae12a02006-01-08 13:34:19 -0800546{
547 /* note: before about 2.6.14-rc1 this would corrupt memory: */
Atsushi Nemoto350d0072007-11-14 16:59:22 -0800548 if (dev != master_dev)
549 spi_unregister_device(to_spi_device(dev));
David Brownell8ae12a02006-01-08 13:34:19 -0800550 return 0;
551}
552
553/**
554 * spi_unregister_master - unregister SPI master controller
555 * @master: the master being unregistered
David Brownell33e34dc2007-05-08 00:32:21 -0700556 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -0800557 *
558 * This call is used only by SPI master controller drivers, which are the
559 * only ones directly touching chip registers.
560 *
561 * This must be called from context that can sleep.
562 */
563void spi_unregister_master(struct spi_master *master)
564{
Jeff Garzik89fc9a12006-12-06 20:35:35 -0800565 int dummy;
566
Atsushi Nemoto350d0072007-11-14 16:59:22 -0800567 dummy = device_for_each_child(master->dev.parent, &master->dev,
568 __unregister);
Tony Jones49dce682007-10-16 01:27:48 -0700569 device_unregister(&master->dev);
David Brownell8ae12a02006-01-08 13:34:19 -0800570}
571EXPORT_SYMBOL_GPL(spi_unregister_master);
572
Dave Young5ed2c832008-01-22 15:14:18 +0800573static int __spi_master_match(struct device *dev, void *data)
574{
575 struct spi_master *m;
576 u16 *bus_num = data;
577
578 m = container_of(dev, struct spi_master, dev);
579 return m->bus_num == *bus_num;
580}
581
David Brownell8ae12a02006-01-08 13:34:19 -0800582/**
583 * spi_busnum_to_master - look up master associated with bus_num
584 * @bus_num: the master's bus number
David Brownell33e34dc2007-05-08 00:32:21 -0700585 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -0800586 *
587 * This call may be used with devices that are registered after
588 * arch init time. It returns a refcounted pointer to the relevant
589 * spi_master (which the caller must release), or NULL if there is
590 * no such master registered.
591 */
592struct spi_master *spi_busnum_to_master(u16 bus_num)
593{
Tony Jones49dce682007-10-16 01:27:48 -0700594 struct device *dev;
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -0800595 struct spi_master *master = NULL;
David Brownell8ae12a02006-01-08 13:34:19 -0800596
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -0400597 dev = class_find_device(&spi_master_class, NULL, &bus_num,
Dave Young5ed2c832008-01-22 15:14:18 +0800598 __spi_master_match);
599 if (dev)
600 master = container_of(dev, struct spi_master, dev);
601 /* reference got in class_find_device */
Atsushi Nemoto1e9a51d2007-01-26 00:56:54 -0800602 return master;
David Brownell8ae12a02006-01-08 13:34:19 -0800603}
604EXPORT_SYMBOL_GPL(spi_busnum_to_master);
605
606
607/*-------------------------------------------------------------------------*/
608
David Brownell7d077192009-06-17 16:26:03 -0700609/* Core methods for SPI master protocol drivers. Some of the
610 * other core methods are currently defined as inline functions.
611 */
612
613/**
614 * spi_setup - setup SPI mode and clock rate
615 * @spi: the device whose settings are being modified
616 * Context: can sleep, and no requests are queued to the device
617 *
618 * SPI protocol drivers may need to update the transfer mode if the
619 * device doesn't work with its default. They may likewise need
620 * to update clock rates or word sizes from initial values. This function
621 * changes those settings, and must be called from a context that can sleep.
622 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
623 * effect the next time the device is selected and data is transferred to
624 * or from it. When this function returns, the spi device is deselected.
625 *
626 * Note that this call will fail if the protocol driver specifies an option
627 * that the underlying controller or its driver does not support. For
628 * example, not all hardware supports wire transfers using nine bit words,
629 * LSB-first wire encoding, or active-high chipselects.
630 */
631int spi_setup(struct spi_device *spi)
632{
David Brownelle7db06b2009-06-17 16:26:04 -0700633 unsigned bad_bits;
David Brownell7d077192009-06-17 16:26:03 -0700634 int status;
635
David Brownelle7db06b2009-06-17 16:26:04 -0700636 /* help drivers fail *cleanly* when they need options
637 * that aren't supported with their current master
638 */
639 bad_bits = spi->mode & ~spi->master->mode_bits;
640 if (bad_bits) {
641 dev_dbg(&spi->dev, "setup: unsupported mode bits %x\n",
642 bad_bits);
643 return -EINVAL;
644 }
645
David Brownell7d077192009-06-17 16:26:03 -0700646 if (!spi->bits_per_word)
647 spi->bits_per_word = 8;
648
649 status = spi->master->setup(spi);
650
651 dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s"
652 "%u bits/w, %u Hz max --> %d\n",
653 (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
654 (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
655 (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
656 (spi->mode & SPI_3WIRE) ? "3wire, " : "",
657 (spi->mode & SPI_LOOP) ? "loopback, " : "",
658 spi->bits_per_word, spi->max_speed_hz,
659 status);
660
661 return status;
662}
663EXPORT_SYMBOL_GPL(spi_setup);
664
665
666/*-------------------------------------------------------------------------*/
667
668/* Utility methods for SPI master protocol drivers, layered on
669 * top of the core. Some other utility methods are defined as
670 * inline functions.
671 */
672
Andrew Morton5d870c82006-01-11 11:23:49 -0800673static void spi_complete(void *arg)
674{
675 complete(arg);
676}
677
David Brownell8ae12a02006-01-08 13:34:19 -0800678/**
679 * spi_sync - blocking/synchronous SPI data transfers
680 * @spi: device with which data will be exchanged
681 * @message: describes the data transfers
David Brownell33e34dc2007-05-08 00:32:21 -0700682 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -0800683 *
684 * This call may only be used from a context that may sleep. The sleep
685 * is non-interruptible, and has no timeout. Low-overhead controller
686 * drivers may DMA directly into and out of the message buffers.
687 *
688 * Note that the SPI device's chip select is active during the message,
689 * and then is normally disabled between messages. Drivers for some
690 * frequently-used devices may want to minimize costs of selecting a chip,
691 * by leaving it selected in anticipation that the next message will go
692 * to the same chip. (That may increase power usage.)
693 *
David Brownell0c868462006-01-08 13:34:25 -0800694 * Also, the caller is guaranteeing that the memory associated with the
695 * message will not be freed before this call returns.
696 *
Marc Pignat9b938b72007-12-04 23:45:10 -0800697 * It returns zero on success, else a negative error code.
David Brownell8ae12a02006-01-08 13:34:19 -0800698 */
699int spi_sync(struct spi_device *spi, struct spi_message *message)
700{
Ingo Molnar60be6b92006-07-03 00:25:26 -0700701 DECLARE_COMPLETION_ONSTACK(done);
David Brownell8ae12a02006-01-08 13:34:19 -0800702 int status;
703
Andrew Morton5d870c82006-01-11 11:23:49 -0800704 message->complete = spi_complete;
David Brownell8ae12a02006-01-08 13:34:19 -0800705 message->context = &done;
706 status = spi_async(spi, message);
Marc Pignat9b938b72007-12-04 23:45:10 -0800707 if (status == 0) {
David Brownell8ae12a02006-01-08 13:34:19 -0800708 wait_for_completion(&done);
Marc Pignat9b938b72007-12-04 23:45:10 -0800709 status = message->status;
710 }
David Brownell8ae12a02006-01-08 13:34:19 -0800711 message->context = NULL;
712 return status;
713}
714EXPORT_SYMBOL_GPL(spi_sync);
715
David Brownella9948b62006-04-02 10:37:40 -0800716/* portable code must never pass more than 32 bytes */
717#define SPI_BUFSIZ max(32,SMP_CACHE_BYTES)
David Brownell8ae12a02006-01-08 13:34:19 -0800718
719static u8 *buf;
720
721/**
722 * spi_write_then_read - SPI synchronous write followed by read
723 * @spi: device with which data will be exchanged
724 * @txbuf: data to be written (need not be dma-safe)
725 * @n_tx: size of txbuf, in bytes
Jiri Pirko27570492009-06-17 16:26:06 -0700726 * @rxbuf: buffer into which data will be read (need not be dma-safe)
727 * @n_rx: size of rxbuf, in bytes
David Brownell33e34dc2007-05-08 00:32:21 -0700728 * Context: can sleep
David Brownell8ae12a02006-01-08 13:34:19 -0800729 *
730 * This performs a half duplex MicroWire style transaction with the
731 * device, sending txbuf and then reading rxbuf. The return value
732 * is zero for success, else a negative errno status code.
David Brownellb8852442006-01-08 13:34:23 -0800733 * This call may only be used from a context that may sleep.
David Brownell8ae12a02006-01-08 13:34:19 -0800734 *
David Brownell0c868462006-01-08 13:34:25 -0800735 * Parameters to this routine are always copied using a small buffer;
David Brownell33e34dc2007-05-08 00:32:21 -0700736 * portable code should never use this for more than 32 bytes.
737 * Performance-sensitive or bulk transfer code should instead use
David Brownell0c868462006-01-08 13:34:25 -0800738 * spi_{async,sync}() calls with dma-safe buffers.
David Brownell8ae12a02006-01-08 13:34:19 -0800739 */
740int spi_write_then_read(struct spi_device *spi,
741 const u8 *txbuf, unsigned n_tx,
742 u8 *rxbuf, unsigned n_rx)
743{
David Brownell068f4072007-12-04 23:45:09 -0800744 static DEFINE_MUTEX(lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800745
746 int status;
747 struct spi_message message;
David Brownellbdff5492009-04-13 14:39:57 -0700748 struct spi_transfer x[2];
David Brownell8ae12a02006-01-08 13:34:19 -0800749 u8 *local_buf;
750
751 /* Use preallocated DMA-safe buffer. We can't avoid copying here,
752 * (as a pure convenience thing), but we can keep heap costs
753 * out of the hot path ...
754 */
755 if ((n_tx + n_rx) > SPI_BUFSIZ)
756 return -EINVAL;
757
Vitaly Wool8275c642006-01-08 13:34:28 -0800758 spi_message_init(&message);
David Brownellbdff5492009-04-13 14:39:57 -0700759 memset(x, 0, sizeof x);
760 if (n_tx) {
761 x[0].len = n_tx;
762 spi_message_add_tail(&x[0], &message);
763 }
764 if (n_rx) {
765 x[1].len = n_rx;
766 spi_message_add_tail(&x[1], &message);
767 }
Vitaly Wool8275c642006-01-08 13:34:28 -0800768
David Brownell8ae12a02006-01-08 13:34:19 -0800769 /* ... unless someone else is using the pre-allocated buffer */
David Brownell068f4072007-12-04 23:45:09 -0800770 if (!mutex_trylock(&lock)) {
David Brownell8ae12a02006-01-08 13:34:19 -0800771 local_buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
772 if (!local_buf)
773 return -ENOMEM;
774 } else
775 local_buf = buf;
776
David Brownell8ae12a02006-01-08 13:34:19 -0800777 memcpy(local_buf, txbuf, n_tx);
David Brownellbdff5492009-04-13 14:39:57 -0700778 x[0].tx_buf = local_buf;
779 x[1].rx_buf = local_buf + n_tx;
David Brownell8ae12a02006-01-08 13:34:19 -0800780
781 /* do the i/o */
David Brownell8ae12a02006-01-08 13:34:19 -0800782 status = spi_sync(spi, &message);
Marc Pignat9b938b72007-12-04 23:45:10 -0800783 if (status == 0)
David Brownellbdff5492009-04-13 14:39:57 -0700784 memcpy(rxbuf, x[1].rx_buf, n_rx);
David Brownell8ae12a02006-01-08 13:34:19 -0800785
David Brownellbdff5492009-04-13 14:39:57 -0700786 if (x[0].tx_buf == buf)
David Brownell068f4072007-12-04 23:45:09 -0800787 mutex_unlock(&lock);
David Brownell8ae12a02006-01-08 13:34:19 -0800788 else
789 kfree(local_buf);
790
791 return status;
792}
793EXPORT_SYMBOL_GPL(spi_write_then_read);
794
795/*-------------------------------------------------------------------------*/
796
797static int __init spi_init(void)
798{
David Brownellb8852442006-01-08 13:34:23 -0800799 int status;
David Brownell8ae12a02006-01-08 13:34:19 -0800800
Christoph Lametere94b1762006-12-06 20:33:17 -0800801 buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
David Brownellb8852442006-01-08 13:34:23 -0800802 if (!buf) {
803 status = -ENOMEM;
804 goto err0;
805 }
806
807 status = bus_register(&spi_bus_type);
808 if (status < 0)
809 goto err1;
810
811 status = class_register(&spi_master_class);
812 if (status < 0)
813 goto err2;
David Brownell8ae12a02006-01-08 13:34:19 -0800814 return 0;
David Brownellb8852442006-01-08 13:34:23 -0800815
816err2:
817 bus_unregister(&spi_bus_type);
818err1:
819 kfree(buf);
820 buf = NULL;
821err0:
822 return status;
David Brownell8ae12a02006-01-08 13:34:19 -0800823}
David Brownellb8852442006-01-08 13:34:23 -0800824
David Brownell8ae12a02006-01-08 13:34:19 -0800825/* board_info is normally registered in arch_initcall(),
826 * but even essential drivers wait till later
David Brownellb8852442006-01-08 13:34:23 -0800827 *
828 * REVISIT only boardinfo really needs static linking. the rest (device and
829 * driver registration) _could_ be dynamically linked (modular) ... costs
830 * include needing to have boardinfo data structures be much more public.
David Brownell8ae12a02006-01-08 13:34:19 -0800831 */
David Brownell673c0c02008-10-15 22:02:46 -0700832postcore_initcall(spi_init);
David Brownell8ae12a02006-01-08 13:34:19 -0800833