diff options
| author | David Brownell <dbrownell@users.sourceforge.net> | 2009-04-21 12:24:49 -0700 |
|---|---|---|
| committer | Linus Torvalds <torvalds@linux-foundation.org> | 2009-04-21 13:41:50 -0700 |
| commit | 6e538aaf50ae782a890cbc02c27950448d8193e1 (patch) | |
| tree | 0e61cacadc2fe403f411e52ba18539bdd52b17e2 /Documentation/spi | |
| parent | 14fadca793e39742f442df53391cdd1437b9262f (diff) | |
| download | linux-3.10-6e538aaf50ae782a890cbc02c27950448d8193e1.tar.gz linux-3.10-6e538aaf50ae782a890cbc02c27950448d8193e1.tar.bz2 linux-3.10-6e538aaf50ae782a890cbc02c27950448d8193e1.zip | |
spi: documentation: emphasise spi_master.setup() semantics
This is a doc-only patch which I hope will reduce the number of
spi_master controller driver patches starting out with a common
implementation bug.
(As in: almost every spi_master driver I see starts out with its
version of this bug. Sigh.)
It just re-emphasizes that the setup() method may be called for one
device while a transfer is active on another ... which means that most
driver implementations shouldn't touch any registers.
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/spi')
| -rw-r--r-- | Documentation/spi/spi-summary | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/spi/spi-summary b/Documentation/spi/spi-summary index 0f5122eb282..4a02d2508bc 100644 --- a/Documentation/spi/spi-summary +++ b/Documentation/spi/spi-summary @@ -511,10 +511,16 @@ SPI MASTER METHODS This sets up the device clock rate, SPI mode, and word sizes. Drivers may change the defaults provided by board_info, and then call spi_setup(spi) to invoke this routine. It may sleep. + Unless each SPI slave has its own configuration registers, don't change them right away ... otherwise drivers could corrupt I/O that's in progress for other SPI devices. + ** BUG ALERT: for some reason the first version of + ** many spi_master drivers seems to get this wrong. + ** When you code setup(), ASSUME that the controller + ** is actively processing transfers for another device. + master->transfer(struct spi_device *spi, struct spi_message *message) This must not sleep. Its responsibility is arrange that the transfer happens and its complete() callback is issued. The two |