spi.c 18.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * spi.c - SPI init/core code
 *
 * Copyright (C) 2005 David Brownell
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <linux/kernel.h>
#include <linux/device.h>
#include <linux/init.h>
#include <linux/cache.h>
25
#include <linux/mutex.h>
26 27 28
#include <linux/spi/spi.h>


29 30 31
/* SPI bustype and spi_master class are registered after board init code
 * provides the SPI device tables, ensuring that both are present by the
 * time controller driver registration causes spi_devices to "enumerate".
32 33 34
 */
static void spidev_release(struct device *dev)
{
35
	struct spi_device	*spi = to_spi_device(dev);
36 37 38 39 40

	/* spi masters may cleanup for released devices */
	if (spi->master->cleanup)
		spi->master->cleanup(spi);

D
David Brownell 已提交
41
	spi_master_put(spi->master);
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
	kfree(dev);
}

static ssize_t
modalias_show(struct device *dev, struct device_attribute *a, char *buf)
{
	const struct spi_device	*spi = to_spi_device(dev);

	return snprintf(buf, BUS_ID_SIZE + 1, "%s\n", spi->modalias);
}

static struct device_attribute spi_dev_attrs[] = {
	__ATTR_RO(modalias),
	__ATTR_NULL,
};

/* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
 * and the sysfs version makes coldplug work too.
 */

static int spi_match_device(struct device *dev, struct device_driver *drv)
{
	const struct spi_device	*spi = to_spi_device(dev);

	return strncmp(spi->modalias, drv->name, BUS_ID_SIZE) == 0;
}

69
static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
70 71 72
{
	const struct spi_device		*spi = to_spi_device(dev);

73
	add_uevent_var(env, "MODALIAS=%s", spi->modalias);
74 75 76 77 78 79 80
	return 0;
}

#ifdef	CONFIG_PM

static int spi_suspend(struct device *dev, pm_message_t message)
{
81
	int			value = 0;
82
	struct spi_driver	*drv = to_spi_driver(dev->driver);
83 84

	/* suspend will stop irqs and dma; no more i/o */
85 86 87 88 89 90
	if (drv) {
		if (drv->suspend)
			value = drv->suspend(to_spi_device(dev), message);
		else
			dev_dbg(dev, "... can't suspend\n");
	}
91 92 93 94 95
	return value;
}

static int spi_resume(struct device *dev)
{
96
	int			value = 0;
97
	struct spi_driver	*drv = to_spi_driver(dev->driver);
98 99

	/* resume may restart the i/o queue */
100 101 102 103 104 105
	if (drv) {
		if (drv->resume)
			value = drv->resume(to_spi_device(dev));
		else
			dev_dbg(dev, "... can't resume\n");
	}
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
	return value;
}

#else
#define spi_suspend	NULL
#define spi_resume	NULL
#endif

struct bus_type spi_bus_type = {
	.name		= "spi",
	.dev_attrs	= spi_dev_attrs,
	.match		= spi_match_device,
	.uevent		= spi_uevent,
	.suspend	= spi_suspend,
	.resume		= spi_resume,
};
EXPORT_SYMBOL_GPL(spi_bus_type);

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145

static int spi_drv_probe(struct device *dev)
{
	const struct spi_driver		*sdrv = to_spi_driver(dev->driver);

	return sdrv->probe(to_spi_device(dev));
}

static int spi_drv_remove(struct device *dev)
{
	const struct spi_driver		*sdrv = to_spi_driver(dev->driver);

	return sdrv->remove(to_spi_device(dev));
}

static void spi_drv_shutdown(struct device *dev)
{
	const struct spi_driver		*sdrv = to_spi_driver(dev->driver);

	sdrv->shutdown(to_spi_device(dev));
}

D
David Brownell 已提交
146 147 148 149 150
/**
 * spi_register_driver - register a SPI driver
 * @sdrv: the driver to register
 * Context: can sleep
 */
151 152 153 154 155 156 157 158 159 160 161 162 163
int spi_register_driver(struct spi_driver *sdrv)
{
	sdrv->driver.bus = &spi_bus_type;
	if (sdrv->probe)
		sdrv->driver.probe = spi_drv_probe;
	if (sdrv->remove)
		sdrv->driver.remove = spi_drv_remove;
	if (sdrv->shutdown)
		sdrv->driver.shutdown = spi_drv_shutdown;
	return driver_register(&sdrv->driver);
}
EXPORT_SYMBOL_GPL(spi_register_driver);

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
/*-------------------------------------------------------------------------*/

/* SPI devices should normally not be created by SPI device drivers; that
 * would make them board-specific.  Similarly with SPI master drivers.
 * Device registration normally goes into like arch/.../mach.../board-YYY.c
 * with other readonly (flashable) information about mainboard devices.
 */

struct boardinfo {
	struct list_head	list;
	unsigned		n_board_info;
	struct spi_board_info	board_info[0];
};

static LIST_HEAD(board_list);
179
static DEFINE_MUTEX(board_lock);
180 181


D
David Brownell 已提交
182 183 184 185 186 187 188
/**
 * spi_new_device - instantiate one new SPI device
 * @master: Controller to which device is connected
 * @chip: Describes the SPI device
 * Context: can sleep
 *
 * On typical mainboards, this is purely internal; and it's not needed
189 190 191 192
 * after board init creates the hard-wired devices.  Some development
 * platforms may not be able to use spi_register_board_info though, and
 * this is exported so that for example a USB or parport based adapter
 * driver could add devices (which it would learn about out-of-band).
193 194
 *
 * Returns the new device, or NULL.
195
 */
196 197
struct spi_device *spi_new_device(struct spi_master *master,
				  struct spi_board_info *chip)
198 199
{
	struct spi_device	*proxy;
T
Tony Jones 已提交
200
	struct device		*dev = master->dev.parent;
201 202
	int			status;

203 204 205 206 207 208 209 210 211 212 213 214 215 216
	/* NOTE:  caller did any chip->bus_num checks necessary.
	 *
	 * Also, unless we change the return value convention to use
	 * error-or-pointer (not NULL-or-pointer), troubleshootability
	 * suggests syslogged diagnostics are best here (ugh).
	 */

	/* Chipselects are numbered 0..max; validate. */
	if (chip->chip_select >= master->num_chipselect) {
		dev_err(dev, "cs%d > max %d\n",
			chip->chip_select,
			master->num_chipselect);
		return NULL;
	}
217

D
David Brownell 已提交
218
	if (!spi_master_get(master))
219 220 221 222 223 224 225 226 227 228 229
		return NULL;

	proxy = kzalloc(sizeof *proxy, GFP_KERNEL);
	if (!proxy) {
		dev_err(dev, "can't alloc dev for cs%d\n",
			chip->chip_select);
		goto fail;
	}
	proxy->master = master;
	proxy->chip_select = chip->chip_select;
	proxy->max_speed_hz = chip->max_speed_hz;
230
	proxy->mode = chip->mode;
231 232 233 234
	proxy->irq = chip->irq;
	proxy->modalias = chip->modalias;

	snprintf(proxy->dev.bus_id, sizeof proxy->dev.bus_id,
T
Tony Jones 已提交
235
			"%s.%u", master->dev.bus_id,
236 237 238 239 240 241 242 243
			chip->chip_select);
	proxy->dev.parent = dev;
	proxy->dev.bus = &spi_bus_type;
	proxy->dev.platform_data = (void *) chip->platform_data;
	proxy->controller_data = chip->controller_data;
	proxy->controller_state = NULL;
	proxy->dev.release = spidev_release;

244
	/* drivers may modify this initial i/o setup */
245 246
	status = master->setup(proxy);
	if (status < 0) {
247
		dev_err(dev, "can't %s %s, status %d\n",
248 249 250 251 252 253 254 255 256
				"setup", proxy->dev.bus_id, status);
		goto fail;
	}

	/* driver core catches callers that misbehave by defining
	 * devices that already exist.
	 */
	status = device_register(&proxy->dev);
	if (status < 0) {
257
		dev_err(dev, "can't %s %s, status %d\n",
258
				"add", proxy->dev.bus_id, status);
259
		goto fail;
260 261 262
	}
	dev_dbg(dev, "registered child %s\n", proxy->dev.bus_id);
	return proxy;
263 264

fail:
D
David Brownell 已提交
265
	spi_master_put(master);
266 267
	kfree(proxy);
	return NULL;
268 269 270
}
EXPORT_SYMBOL_GPL(spi_new_device);

D
David Brownell 已提交
271 272 273 274 275 276
/**
 * spi_register_board_info - register SPI devices for a given board
 * @info: array of chip descriptors
 * @n: how many descriptors are provided
 * Context: can sleep
 *
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
 * Board-specific early init code calls this (probably during arch_initcall)
 * with segments of the SPI device table.  Any device nodes are created later,
 * after the relevant parent SPI controller (bus_num) is defined.  We keep
 * this table of devices forever, so that reloading a controller driver will
 * not make Linux forget about these hard-wired devices.
 *
 * Other code can also call this, e.g. a particular add-on board might provide
 * SPI devices through its expansion connector, so code initializing that board
 * would naturally declare its SPI devices.
 *
 * The board info passed can safely be __initdata ... but be careful of
 * any embedded pointers (platform_data, etc), they're copied as-is.
 */
int __init
spi_register_board_info(struct spi_board_info const *info, unsigned n)
{
	struct boardinfo	*bi;

295
	bi = kmalloc(sizeof(*bi) + n * sizeof *info, GFP_KERNEL);
296 297 298
	if (!bi)
		return -ENOMEM;
	bi->n_board_info = n;
299
	memcpy(bi->board_info, info, n * sizeof *info);
300

301
	mutex_lock(&board_lock);
302
	list_add_tail(&bi->list, &board_list);
303
	mutex_unlock(&board_lock);
304 305 306 307 308 309 310
	return 0;
}

/* FIXME someone should add support for a __setup("spi", ...) that
 * creates board info from kernel command lines
 */

311
static void scan_boardinfo(struct spi_master *master)
312 313 314
{
	struct boardinfo	*bi;

315
	mutex_lock(&board_lock);
316 317 318 319 320 321 322
	list_for_each_entry(bi, &board_list, list) {
		struct spi_board_info	*chip = bi->board_info;
		unsigned		n;

		for (n = bi->n_board_info; n > 0; n--, chip++) {
			if (chip->bus_num != master->bus_num)
				continue;
323 324
			/* NOTE: this relies on spi_new_device to
			 * issue diagnostics when given bogus inputs
325 326 327 328
			 */
			(void) spi_new_device(master, chip);
		}
	}
329
	mutex_unlock(&board_lock);
330 331 332 333
}

/*-------------------------------------------------------------------------*/

T
Tony Jones 已提交
334
static void spi_master_release(struct device *dev)
335 336 337
{
	struct spi_master *master;

T
Tony Jones 已提交
338
	master = container_of(dev, struct spi_master, dev);
339 340 341 342 343 344
	kfree(master);
}

static struct class spi_master_class = {
	.name		= "spi_master",
	.owner		= THIS_MODULE,
T
Tony Jones 已提交
345
	.dev_release	= spi_master_release,
346 347 348 349 350 351
};


/**
 * spi_alloc_master - allocate SPI master controller
 * @dev: the controller, possibly using the platform_bus
D
David Brownell 已提交
352
 * @size: how much zeroed driver-private data to allocate; the pointer to this
T
Tony Jones 已提交
353
 *	memory is in the driver_data field of the returned device,
D
David Brownell 已提交
354
 *	accessible with spi_master_get_devdata().
D
David Brownell 已提交
355
 * Context: can sleep
356 357 358
 *
 * This call is used only by SPI master controller drivers, which are the
 * only ones directly touching chip registers.  It's how they allocate
D
dmitry pervushin 已提交
359
 * an spi_master structure, prior to calling spi_register_master().
360 361 362 363 364
 *
 * This must be called from context that can sleep.  It returns the SPI
 * master structure on success, else NULL.
 *
 * The caller is responsible for assigning the bus number and initializing
D
dmitry pervushin 已提交
365
 * the master's methods before calling spi_register_master(); and (after errors
D
David Brownell 已提交
366
 * adding the device) calling spi_master_put() to prevent a memory leak.
367
 */
368
struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
369 370 371
{
	struct spi_master	*master;

D
David Brownell 已提交
372 373 374
	if (!dev)
		return NULL;

375
	master = kzalloc(size + sizeof *master, GFP_KERNEL);
376 377 378
	if (!master)
		return NULL;

T
Tony Jones 已提交
379 380 381
	device_initialize(&master->dev);
	master->dev.class = &spi_master_class;
	master->dev.parent = get_device(dev);
D
David Brownell 已提交
382
	spi_master_set_devdata(master, &master[1]);
383 384 385 386 387 388 389 390

	return master;
}
EXPORT_SYMBOL_GPL(spi_alloc_master);

/**
 * spi_register_master - register SPI master controller
 * @master: initialized master, originally from spi_alloc_master()
D
David Brownell 已提交
391
 * Context: can sleep
392 393 394 395 396 397 398 399 400 401 402 403 404
 *
 * SPI master controllers connect to their drivers using some non-SPI bus,
 * such as the platform bus.  The final stage of probe() in that code
 * includes calling spi_register_master() to hook up to this SPI bus glue.
 *
 * SPI controllers use board specific (often SOC specific) bus numbers,
 * and board-specific addressing for SPI devices combines those numbers
 * with chip select numbers.  Since SPI does not directly support dynamic
 * device identification, boards need configuration tables telling which
 * chip is at which address.
 *
 * This must be called from context that can sleep.  It returns zero on
 * success, else a negative error code (dropping the master's refcount).
D
David Brownell 已提交
405 406
 * After a successful return, the caller is responsible for calling
 * spi_unregister_master().
407
 */
408
int spi_register_master(struct spi_master *master)
409
{
410
	static atomic_t		dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
T
Tony Jones 已提交
411
	struct device		*dev = master->dev.parent;
412 413 414
	int			status = -ENODEV;
	int			dynamic = 0;

D
David Brownell 已提交
415 416 417
	if (!dev)
		return -ENODEV;

418 419 420 421 422 423
	/* even if it's just one always-selected device, there must
	 * be at least one chipselect
	 */
	if (master->num_chipselect == 0)
		return -EINVAL;

424
	/* convention:  dynamically assigned bus IDs count down from the max */
425
	if (master->bus_num < 0) {
426 427 428
		/* FIXME switch to an IDR based scheme, something like
		 * I2C now uses, so we can't run out of "dynamic" IDs
		 */
429
		master->bus_num = atomic_dec_return(&dyn_bus_id);
430
		dynamic = 1;
431 432 433 434 435
	}

	/* register the device, then userspace will see it.
	 * registration fails if the bus ID is in use.
	 */
T
Tony Jones 已提交
436
	snprintf(master->dev.bus_id, sizeof master->dev.bus_id,
437
		"spi%u", master->bus_num);
T
Tony Jones 已提交
438
	status = device_add(&master->dev);
439
	if (status < 0)
440
		goto done;
T
Tony Jones 已提交
441
	dev_dbg(dev, "registered master %s%s\n", master->dev.bus_id,
442 443 444 445 446 447 448 449 450 451 452
			dynamic ? " (dynamic)" : "");

	/* populate children from any spi device tables */
	scan_boardinfo(master);
	status = 0;
done:
	return status;
}
EXPORT_SYMBOL_GPL(spi_register_master);


453
static int __unregister(struct device *dev, void *master_dev)
454 455
{
	/* note: before about 2.6.14-rc1 this would corrupt memory: */
456 457
	if (dev != master_dev)
		spi_unregister_device(to_spi_device(dev));
458 459 460 461 462 463
	return 0;
}

/**
 * spi_unregister_master - unregister SPI master controller
 * @master: the master being unregistered
D
David Brownell 已提交
464
 * Context: can sleep
465 466 467 468 469 470 471 472
 *
 * This call is used only by SPI master controller drivers, which are the
 * only ones directly touching chip registers.
 *
 * This must be called from context that can sleep.
 */
void spi_unregister_master(struct spi_master *master)
{
473 474
	int dummy;

475 476
	dummy = device_for_each_child(master->dev.parent, &master->dev,
					__unregister);
T
Tony Jones 已提交
477
	device_unregister(&master->dev);
478 479 480
}
EXPORT_SYMBOL_GPL(spi_unregister_master);

D
Dave Young 已提交
481 482 483 484 485 486 487 488 489
static int __spi_master_match(struct device *dev, void *data)
{
	struct spi_master *m;
	u16 *bus_num = data;

	m = container_of(dev, struct spi_master, dev);
	return m->bus_num == *bus_num;
}

490 491 492
/**
 * spi_busnum_to_master - look up master associated with bus_num
 * @bus_num: the master's bus number
D
David Brownell 已提交
493
 * Context: can sleep
494 495 496 497 498 499 500 501
 *
 * This call may be used with devices that are registered after
 * arch init time.  It returns a refcounted pointer to the relevant
 * spi_master (which the caller must release), or NULL if there is
 * no such master registered.
 */
struct spi_master *spi_busnum_to_master(u16 bus_num)
{
T
Tony Jones 已提交
502
	struct device		*dev;
503
	struct spi_master	*master = NULL;
D
Dave Young 已提交
504

505
	dev = class_find_device(&spi_master_class, NULL, &bus_num,
D
Dave Young 已提交
506 507 508 509
				__spi_master_match);
	if (dev)
		master = container_of(dev, struct spi_master, dev);
	/* reference got in class_find_device */
510
	return master;
511 512 513 514 515 516
}
EXPORT_SYMBOL_GPL(spi_busnum_to_master);


/*-------------------------------------------------------------------------*/

517 518 519 520 521
static void spi_complete(void *arg)
{
	complete(arg);
}

522 523 524 525
/**
 * spi_sync - blocking/synchronous SPI data transfers
 * @spi: device with which data will be exchanged
 * @message: describes the data transfers
D
David Brownell 已提交
526
 * Context: can sleep
527 528 529 530 531 532 533 534 535 536 537
 *
 * This call may only be used from a context that may sleep.  The sleep
 * is non-interruptible, and has no timeout.  Low-overhead controller
 * drivers may DMA directly into and out of the message buffers.
 *
 * Note that the SPI device's chip select is active during the message,
 * and then is normally disabled between messages.  Drivers for some
 * frequently-used devices may want to minimize costs of selecting a chip,
 * by leaving it selected in anticipation that the next message will go
 * to the same chip.  (That may increase power usage.)
 *
D
David Brownell 已提交
538 539 540
 * Also, the caller is guaranteeing that the memory associated with the
 * message will not be freed before this call returns.
 *
541
 * It returns zero on success, else a negative error code.
542 543 544
 */
int spi_sync(struct spi_device *spi, struct spi_message *message)
{
545
	DECLARE_COMPLETION_ONSTACK(done);
546 547
	int status;

548
	message->complete = spi_complete;
549 550
	message->context = &done;
	status = spi_async(spi, message);
551
	if (status == 0) {
552
		wait_for_completion(&done);
553 554
		status = message->status;
	}
555 556 557 558 559
	message->context = NULL;
	return status;
}
EXPORT_SYMBOL_GPL(spi_sync);

560 561
/* portable code must never pass more than 32 bytes */
#define	SPI_BUFSIZ	max(32,SMP_CACHE_BYTES)
562 563 564 565 566 567 568 569 570 571

static u8	*buf;

/**
 * spi_write_then_read - SPI synchronous write followed by read
 * @spi: device with which data will be exchanged
 * @txbuf: data to be written (need not be dma-safe)
 * @n_tx: size of txbuf, in bytes
 * @rxbuf: buffer into which data will be read
 * @n_rx: size of rxbuf, in bytes (need not be dma-safe)
D
David Brownell 已提交
572
 * Context: can sleep
573 574 575 576
 *
 * This performs a half duplex MicroWire style transaction with the
 * device, sending txbuf and then reading rxbuf.  The return value
 * is zero for success, else a negative errno status code.
577
 * This call may only be used from a context that may sleep.
578
 *
D
David Brownell 已提交
579
 * Parameters to this routine are always copied using a small buffer;
D
David Brownell 已提交
580 581
 * portable code should never use this for more than 32 bytes.
 * Performance-sensitive or bulk transfer code should instead use
D
David Brownell 已提交
582
 * spi_{async,sync}() calls with dma-safe buffers.
583 584 585 586 587
 */
int spi_write_then_read(struct spi_device *spi,
		const u8 *txbuf, unsigned n_tx,
		u8 *rxbuf, unsigned n_rx)
{
D
David Brownell 已提交
588
	static DEFINE_MUTEX(lock);
589 590 591 592 593 594 595 596 597 598 599 600 601

	int			status;
	struct spi_message	message;
	struct spi_transfer	x[2];
	u8			*local_buf;

	/* Use preallocated DMA-safe buffer.  We can't avoid copying here,
	 * (as a pure convenience thing), but we can keep heap costs
	 * out of the hot path ...
	 */
	if ((n_tx + n_rx) > SPI_BUFSIZ)
		return -EINVAL;

602 603 604 605 606 607 608 609 610 611 612
	spi_message_init(&message);
	memset(x, 0, sizeof x);
	if (n_tx) {
		x[0].len = n_tx;
		spi_message_add_tail(&x[0], &message);
	}
	if (n_rx) {
		x[1].len = n_rx;
		spi_message_add_tail(&x[1], &message);
	}

613
	/* ... unless someone else is using the pre-allocated buffer */
D
David Brownell 已提交
614
	if (!mutex_trylock(&lock)) {
615 616 617 618 619 620 621 622 623 624 625 626
		local_buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
		if (!local_buf)
			return -ENOMEM;
	} else
		local_buf = buf;

	memcpy(local_buf, txbuf, n_tx);
	x[0].tx_buf = local_buf;
	x[1].rx_buf = local_buf + n_tx;

	/* do the i/o */
	status = spi_sync(spi, &message);
627
	if (status == 0)
628 629 630
		memcpy(rxbuf, x[1].rx_buf, n_rx);

	if (x[0].tx_buf == buf)
D
David Brownell 已提交
631
		mutex_unlock(&lock);
632 633 634 635 636 637 638 639 640 641 642
	else
		kfree(local_buf);

	return status;
}
EXPORT_SYMBOL_GPL(spi_write_then_read);

/*-------------------------------------------------------------------------*/

static int __init spi_init(void)
{
643 644
	int	status;

645
	buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
646 647 648 649 650 651 652 653
	if (!buf) {
		status = -ENOMEM;
		goto err0;
	}

	status = bus_register(&spi_bus_type);
	if (status < 0)
		goto err1;
654

655 656 657
	status = class_register(&spi_master_class);
	if (status < 0)
		goto err2;
658
	return 0;
659 660 661 662 663 664 665 666

err2:
	bus_unregister(&spi_bus_type);
err1:
	kfree(buf);
	buf = NULL;
err0:
	return status;
667
}
668

669 670
/* board_info is normally registered in arch_initcall(),
 * but even essential drivers wait till later
671 672 673 674
 *
 * REVISIT only boardinfo really needs static linking. the rest (device and
 * driver registration) _could_ be dynamically linked (modular) ... costs
 * include needing to have boardinfo data structures be much more public.
675 676 677
 */
subsys_initcall(spi_init);