diff mbox

[v3,2/3] Doc: spi: document the transfer_one spi_master callback

Message ID 22346e0270dfd9b7892ff313654a6a2001654ea2.1390681463.git.baruch@tkos.co.il (mailing list archive)
State Accepted
Commit 18cc0adb132b390d026c574deec29bf182aede51
Headers show

Commit Message

Baruch Siach Jan. 25, 2014, 8:36 p.m. UTC 
Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 Documentation/spi/spi-summary | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Mark Brown Jan. 27, 2014, 6:44 p.m. UTC | #1 
On Sat, Jan 25, 2014 at 10:36:14PM +0200, Baruch Siach wrote:
> Signed-off-by: Baruch Siach <baruch@tkos.co.il>

Applied, thanks.
diff mbox

Patch

diff --git a/Documentation/spi/spi-summary b/Documentation/spi/spi-summary
index f21edb983413..7192c0b6dd54 100644
--- a/Documentation/spi/spi-summary
+++ b/Documentation/spi/spi-summary
@@ -545,6 +545,21 @@  SPI MASTER METHODS
 	spi_finalize_current_message() so the subsystem can issue the next
 	transfer. This may sleep.
 
+    master->transfer_one(struct spi_master *master, struct spi_device *spi,
+			 struct spi_transfer *transfer)
+	The subsystem calls the driver to transfer a single transfer while
+	queuing transfers that arrive in the meantime. When the driver is
+	finished with this transfer, it must call
+	spi_finalize_current_transfer() so the subsystem can issue the next
+	transfer. This may sleep. Note: transfer_one and transfer_one_message
+	are mutually exclusive; when both are set, the generic subsystem does
+	not call your transfer_one callback.
+
+	Return values:
+	negative errno: error
+	0: transfer is finished
+	1: transfer is still in progress
+
     DEPRECATED METHODS
 
     master->transfer(struct spi_device *spi, struct spi_message *message)