spi.c 23.2 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
#include <linux/mod_devicetable.h>
27 28 29
#include <linux/spi/spi.h>


30 31 32
/* 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".
33 34 35
 */
static void spidev_release(struct device *dev)
{
36
	struct spi_device	*spi = to_spi_device(dev);
37 38 39 40 41

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

D
David Brownell 已提交
42
	spi_master_put(spi->master);
43 44 45 46 47 48 49 50
	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);

51
	return sprintf(buf, "%s\n", spi->modalias);
52 53 54 55 56 57 58 59 60 61 62
}

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.
 */

63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
						const struct spi_device *sdev)
{
	while (id->name[0]) {
		if (!strcmp(sdev->modalias, id->name))
			return id;
		id++;
	}
	return NULL;
}

const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
{
	const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);

	return spi_match_id(sdrv->id_table, sdev);
}
EXPORT_SYMBOL_GPL(spi_get_device_id);

82 83 84
static int spi_match_device(struct device *dev, struct device_driver *drv)
{
	const struct spi_device	*spi = to_spi_device(dev);
85 86 87 88
	const struct spi_driver	*sdrv = to_spi_driver(drv);

	if (sdrv->id_table)
		return !!spi_match_id(sdrv->id_table, spi);
89

90
	return strcmp(spi->modalias, drv->name) == 0;
91 92
}

93
static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
94 95 96
{
	const struct spi_device		*spi = to_spi_device(dev);

97
	add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
98 99 100 101 102 103 104
	return 0;
}

#ifdef	CONFIG_PM

static int spi_suspend(struct device *dev, pm_message_t message)
{
105
	int			value = 0;
106
	struct spi_driver	*drv = to_spi_driver(dev->driver);
107 108

	/* suspend will stop irqs and dma; no more i/o */
109 110 111 112 113 114
	if (drv) {
		if (drv->suspend)
			value = drv->suspend(to_spi_device(dev), message);
		else
			dev_dbg(dev, "... can't suspend\n");
	}
115 116 117 118 119
	return value;
}

static int spi_resume(struct device *dev)
{
120
	int			value = 0;
121
	struct spi_driver	*drv = to_spi_driver(dev->driver);
122 123

	/* resume may restart the i/o queue */
124 125 126 127 128 129
	if (drv) {
		if (drv->resume)
			value = drv->resume(to_spi_device(dev));
		else
			dev_dbg(dev, "... can't resume\n");
	}
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
	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);

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169

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 已提交
170 171 172 173 174
/**
 * spi_register_driver - register a SPI driver
 * @sdrv: the driver to register
 * Context: can sleep
 */
175 176 177 178 179 180 181 182 183 184 185 186 187
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);

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
/*-------------------------------------------------------------------------*/

/* 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);
203
static DEFINE_MUTEX(board_lock);
204

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
/**
 * spi_alloc_device - Allocate a new SPI device
 * @master: Controller to which device is connected
 * Context: can sleep
 *
 * Allows a driver to allocate and initialize a spi_device without
 * registering it immediately.  This allows a driver to directly
 * fill the spi_device with device parameters before calling
 * spi_add_device() on it.
 *
 * Caller is responsible to call spi_add_device() on the returned
 * spi_device structure to add it to the SPI master.  If the caller
 * needs to discard the spi_device without adding it, then it should
 * call spi_dev_put() on it.
 *
 * Returns a pointer to the new device, or NULL.
 */
struct spi_device *spi_alloc_device(struct spi_master *master)
{
	struct spi_device	*spi;
	struct device		*dev = master->dev.parent;

	if (!spi_master_get(master))
		return NULL;

	spi = kzalloc(sizeof *spi, GFP_KERNEL);
	if (!spi) {
		dev_err(dev, "cannot alloc spi_device\n");
		spi_master_put(master);
		return NULL;
	}

	spi->master = master;
	spi->dev.parent = dev;
	spi->dev.bus = &spi_bus_type;
	spi->dev.release = spidev_release;
	device_initialize(&spi->dev);
	return spi;
}
EXPORT_SYMBOL_GPL(spi_alloc_device);

/**
 * spi_add_device - Add spi_device allocated with spi_alloc_device
 * @spi: spi_device to register
 *
 * Companion function to spi_alloc_device.  Devices allocated with
 * spi_alloc_device can be added onto the spi bus with this function.
 *
253
 * Returns 0 on success; negative errno on failure
254 255 256
 */
int spi_add_device(struct spi_device *spi)
{
257
	static DEFINE_MUTEX(spi_add_lock);
258 259 260 261 262 263 264 265 266 267 268 269
	struct device *dev = spi->master->dev.parent;
	int status;

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

	/* Set the bus ID string */
270
	dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
271 272
			spi->chip_select);

273 274 275 276 277 278 279

	/* We need to make sure there's no other device with this
	 * chipselect **BEFORE** we call setup(), else we'll trash
	 * its configuration.  Lock against concurrent add() calls.
	 */
	mutex_lock(&spi_add_lock);

280
	if (bus_find_device_by_name(&spi_bus_type, NULL, dev_name(&spi->dev))
281 282 283 284 285 286 287 288 289 290 291
			!= NULL) {
		dev_err(dev, "chipselect %d already in use\n",
				spi->chip_select);
		status = -EBUSY;
		goto done;
	}

	/* Drivers may modify this initial i/o setup, but will
	 * normally rely on the device being setup.  Devices
	 * using SPI_CS_HIGH can't coexist well otherwise...
	 */
292
	status = spi_setup(spi);
293 294
	if (status < 0) {
		dev_err(dev, "can't %s %s, status %d\n",
295
				"setup", dev_name(&spi->dev), status);
296
		goto done;
297 298
	}

299
	/* Device may be bound to an active driver when this returns */
300
	status = device_add(&spi->dev);
301
	if (status < 0)
302
		dev_err(dev, "can't %s %s, status %d\n",
303
				"add", dev_name(&spi->dev), status);
304
	else
305
		dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
306

307 308 309
done:
	mutex_unlock(&spi_add_lock);
	return status;
310 311
}
EXPORT_SYMBOL_GPL(spi_add_device);
312

D
David Brownell 已提交
313 314 315 316 317 318 319
/**
 * 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
320 321 322 323
 * 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).
324 325
 *
 * Returns the new device, or NULL.
326
 */
327 328
struct spi_device *spi_new_device(struct spi_master *master,
				  struct spi_board_info *chip)
329 330 331 332
{
	struct spi_device	*proxy;
	int			status;

333 334 335 336 337 338 339
	/* 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).
	 */

340 341
	proxy = spi_alloc_device(master);
	if (!proxy)
342 343
		return NULL;

344 345
	WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));

346 347
	proxy->chip_select = chip->chip_select;
	proxy->max_speed_hz = chip->max_speed_hz;
348
	proxy->mode = chip->mode;
349
	proxy->irq = chip->irq;
350
	strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
351 352 353 354
	proxy->dev.platform_data = (void *) chip->platform_data;
	proxy->controller_data = chip->controller_data;
	proxy->controller_state = NULL;

355
	status = spi_add_device(proxy);
356
	if (status < 0) {
357 358
		spi_dev_put(proxy);
		return NULL;
359 360 361 362 363 364
	}

	return proxy;
}
EXPORT_SYMBOL_GPL(spi_new_device);

D
David Brownell 已提交
365 366 367 368 369 370
/**
 * 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
 *
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
 * 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;

389
	bi = kmalloc(sizeof(*bi) + n * sizeof *info, GFP_KERNEL);
390 391 392
	if (!bi)
		return -ENOMEM;
	bi->n_board_info = n;
393
	memcpy(bi->board_info, info, n * sizeof *info);
394

395
	mutex_lock(&board_lock);
396
	list_add_tail(&bi->list, &board_list);
397
	mutex_unlock(&board_lock);
398 399 400 401 402 403 404
	return 0;
}

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

405
static void scan_boardinfo(struct spi_master *master)
406 407 408
{
	struct boardinfo	*bi;

409
	mutex_lock(&board_lock);
410 411 412 413 414 415 416
	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;
417 418
			/* NOTE: this relies on spi_new_device to
			 * issue diagnostics when given bogus inputs
419 420 421 422
			 */
			(void) spi_new_device(master, chip);
		}
	}
423
	mutex_unlock(&board_lock);
424 425 426 427
}

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

T
Tony Jones 已提交
428
static void spi_master_release(struct device *dev)
429 430 431
{
	struct spi_master *master;

T
Tony Jones 已提交
432
	master = container_of(dev, struct spi_master, dev);
433 434 435 436 437 438
	kfree(master);
}

static struct class spi_master_class = {
	.name		= "spi_master",
	.owner		= THIS_MODULE,
T
Tony Jones 已提交
439
	.dev_release	= spi_master_release,
440 441 442 443 444 445
};


/**
 * spi_alloc_master - allocate SPI master controller
 * @dev: the controller, possibly using the platform_bus
D
David Brownell 已提交
446
 * @size: how much zeroed driver-private data to allocate; the pointer to this
T
Tony Jones 已提交
447
 *	memory is in the driver_data field of the returned device,
D
David Brownell 已提交
448
 *	accessible with spi_master_get_devdata().
D
David Brownell 已提交
449
 * Context: can sleep
450 451 452
 *
 * 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 已提交
453
 * an spi_master structure, prior to calling spi_register_master().
454 455 456 457 458
 *
 * 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 已提交
459
 * the master's methods before calling spi_register_master(); and (after errors
D
David Brownell 已提交
460
 * adding the device) calling spi_master_put() to prevent a memory leak.
461
 */
462
struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
463 464 465
{
	struct spi_master	*master;

D
David Brownell 已提交
466 467 468
	if (!dev)
		return NULL;

469
	master = kzalloc(size + sizeof *master, GFP_KERNEL);
470 471 472
	if (!master)
		return NULL;

T
Tony Jones 已提交
473 474 475
	device_initialize(&master->dev);
	master->dev.class = &spi_master_class;
	master->dev.parent = get_device(dev);
D
David Brownell 已提交
476
	spi_master_set_devdata(master, &master[1]);
477 478 479 480 481 482 483 484

	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 已提交
485
 * Context: can sleep
486 487 488 489 490 491 492 493 494 495 496 497 498
 *
 * 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 已提交
499 500
 * After a successful return, the caller is responsible for calling
 * spi_unregister_master().
501
 */
502
int spi_register_master(struct spi_master *master)
503
{
504
	static atomic_t		dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
T
Tony Jones 已提交
505
	struct device		*dev = master->dev.parent;
506 507 508
	int			status = -ENODEV;
	int			dynamic = 0;

D
David Brownell 已提交
509 510 511
	if (!dev)
		return -ENODEV;

512 513 514 515 516 517
	/* even if it's just one always-selected device, there must
	 * be at least one chipselect
	 */
	if (master->num_chipselect == 0)
		return -EINVAL;

518
	/* convention:  dynamically assigned bus IDs count down from the max */
519
	if (master->bus_num < 0) {
520 521 522
		/* FIXME switch to an IDR based scheme, something like
		 * I2C now uses, so we can't run out of "dynamic" IDs
		 */
523
		master->bus_num = atomic_dec_return(&dyn_bus_id);
524
		dynamic = 1;
525 526 527 528 529
	}

	/* register the device, then userspace will see it.
	 * registration fails if the bus ID is in use.
	 */
530
	dev_set_name(&master->dev, "spi%u", master->bus_num);
T
Tony Jones 已提交
531
	status = device_add(&master->dev);
532
	if (status < 0)
533
		goto done;
534
	dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
535 536 537 538 539 540 541 542 543 544 545
			dynamic ? " (dynamic)" : "");

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


546
static int __unregister(struct device *dev, void *master_dev)
547 548
{
	/* note: before about 2.6.14-rc1 this would corrupt memory: */
549 550
	if (dev != master_dev)
		spi_unregister_device(to_spi_device(dev));
551 552 553 554 555 556
	return 0;
}

/**
 * spi_unregister_master - unregister SPI master controller
 * @master: the master being unregistered
D
David Brownell 已提交
557
 * Context: can sleep
558 559 560 561 562 563 564 565
 *
 * 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)
{
566 567
	int dummy;

568 569
	dummy = device_for_each_child(master->dev.parent, &master->dev,
					__unregister);
T
Tony Jones 已提交
570
	device_unregister(&master->dev);
571 572 573
}
EXPORT_SYMBOL_GPL(spi_unregister_master);

D
Dave Young 已提交
574 575 576 577 578 579 580 581 582
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;
}

583 584 585
/**
 * spi_busnum_to_master - look up master associated with bus_num
 * @bus_num: the master's bus number
D
David Brownell 已提交
586
 * Context: can sleep
587 588 589 590 591 592 593 594
 *
 * 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 已提交
595
	struct device		*dev;
596
	struct spi_master	*master = NULL;
D
Dave Young 已提交
597

598
	dev = class_find_device(&spi_master_class, NULL, &bus_num,
D
Dave Young 已提交
599 600 601 602
				__spi_master_match);
	if (dev)
		master = container_of(dev, struct spi_master, dev);
	/* reference got in class_find_device */
603
	return master;
604 605 606 607 608 609
}
EXPORT_SYMBOL_GPL(spi_busnum_to_master);


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

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
/* Core methods for SPI master protocol drivers.  Some of the
 * other core methods are currently defined as inline functions.
 */

/**
 * spi_setup - setup SPI mode and clock rate
 * @spi: the device whose settings are being modified
 * Context: can sleep, and no requests are queued to the device
 *
 * SPI protocol drivers may need to update the transfer mode if the
 * device doesn't work with its default.  They may likewise need
 * to update clock rates or word sizes from initial values.  This function
 * changes those settings, and must be called from a context that can sleep.
 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
 * effect the next time the device is selected and data is transferred to
 * or from it.  When this function returns, the spi device is deselected.
 *
 * Note that this call will fail if the protocol driver specifies an option
 * that the underlying controller or its driver does not support.  For
 * example, not all hardware supports wire transfers using nine bit words,
 * LSB-first wire encoding, or active-high chipselects.
 */
int spi_setup(struct spi_device *spi)
{
634
	unsigned	bad_bits;
635 636
	int		status;

637 638 639 640 641 642 643 644 645 646
	/* help drivers fail *cleanly* when they need options
	 * that aren't supported with their current master
	 */
	bad_bits = spi->mode & ~spi->master->mode_bits;
	if (bad_bits) {
		dev_dbg(&spi->dev, "setup: unsupported mode bits %x\n",
			bad_bits);
		return -EINVAL;
	}

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
	if (!spi->bits_per_word)
		spi->bits_per_word = 8;

	status = spi->master->setup(spi);

	dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s"
				"%u bits/w, %u Hz max --> %d\n",
			(int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
			(spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
			(spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
			(spi->mode & SPI_3WIRE) ? "3wire, " : "",
			(spi->mode & SPI_LOOP) ? "loopback, " : "",
			spi->bits_per_word, spi->max_speed_hz,
			status);

	return status;
}
EXPORT_SYMBOL_GPL(spi_setup);


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

/* Utility methods for SPI master protocol drivers, layered on
 * top of the core.  Some other utility methods are defined as
 * inline functions.
 */

674 675 676 677 678
static void spi_complete(void *arg)
{
	complete(arg);
}

679 680 681 682
/**
 * spi_sync - blocking/synchronous SPI data transfers
 * @spi: device with which data will be exchanged
 * @message: describes the data transfers
D
David Brownell 已提交
683
 * Context: can sleep
684 685 686 687 688 689 690 691 692 693 694
 *
 * 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 已提交
695 696 697
 * Also, the caller is guaranteeing that the memory associated with the
 * message will not be freed before this call returns.
 *
698
 * It returns zero on success, else a negative error code.
699 700 701
 */
int spi_sync(struct spi_device *spi, struct spi_message *message)
{
702
	DECLARE_COMPLETION_ONSTACK(done);
703 704
	int status;

705
	message->complete = spi_complete;
706 707
	message->context = &done;
	status = spi_async(spi, message);
708
	if (status == 0) {
709
		wait_for_completion(&done);
710 711
		status = message->status;
	}
712 713 714 715 716
	message->context = NULL;
	return status;
}
EXPORT_SYMBOL_GPL(spi_sync);

717 718
/* portable code must never pass more than 32 bytes */
#define	SPI_BUFSIZ	max(32,SMP_CACHE_BYTES)
719 720 721 722 723 724 725 726

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
727 728
 * @rxbuf: buffer into which data will be read (need not be dma-safe)
 * @n_rx: size of rxbuf, in bytes
D
David Brownell 已提交
729
 * Context: can sleep
730 731 732 733
 *
 * 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.
734
 * This call may only be used from a context that may sleep.
735
 *
D
David Brownell 已提交
736
 * Parameters to this routine are always copied using a small buffer;
D
David Brownell 已提交
737 738
 * portable code should never use this for more than 32 bytes.
 * Performance-sensitive or bulk transfer code should instead use
D
David Brownell 已提交
739
 * spi_{async,sync}() calls with dma-safe buffers.
740 741 742 743 744
 */
int spi_write_then_read(struct spi_device *spi,
		const u8 *txbuf, unsigned n_tx,
		u8 *rxbuf, unsigned n_rx)
{
D
David Brownell 已提交
745
	static DEFINE_MUTEX(lock);
746 747 748

	int			status;
	struct spi_message	message;
749
	struct spi_transfer	x[2];
750 751 752 753 754 755 756 757 758
	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;

759
	spi_message_init(&message);
760 761 762 763 764 765 766 767 768
	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);
	}
769

770
	/* ... unless someone else is using the pre-allocated buffer */
D
David Brownell 已提交
771
	if (!mutex_trylock(&lock)) {
772 773 774 775 776 777 778
		local_buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
		if (!local_buf)
			return -ENOMEM;
	} else
		local_buf = buf;

	memcpy(local_buf, txbuf, n_tx);
779 780
	x[0].tx_buf = local_buf;
	x[1].rx_buf = local_buf + n_tx;
781 782 783

	/* do the i/o */
	status = spi_sync(spi, &message);
784
	if (status == 0)
785
		memcpy(rxbuf, x[1].rx_buf, n_rx);
786

787
	if (x[0].tx_buf == buf)
D
David Brownell 已提交
788
		mutex_unlock(&lock);
789 790 791 792 793 794 795 796 797 798 799
	else
		kfree(local_buf);

	return status;
}
EXPORT_SYMBOL_GPL(spi_write_then_read);

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

static int __init spi_init(void)
{
800 801
	int	status;

802
	buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
803 804 805 806 807 808 809 810
	if (!buf) {
		status = -ENOMEM;
		goto err0;
	}

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

812 813 814
	status = class_register(&spi_master_class);
	if (status < 0)
		goto err2;
815
	return 0;
816 817 818 819 820 821 822 823

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

826 827
/* board_info is normally registered in arch_initcall(),
 * but even essential drivers wait till later
828 829 830 831
 *
 * 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.
832
 */
833
postcore_initcall(spi_init);
834