diff mbox

[v3,1/3] spi: spi.h: clarify the documentation of transfer_one

Message ID 598dd86dc07d794d7cd19a3259ea71618ba150bd.1390681463.git.baruch@tkos.co.il (mailing list archive)
State Accepted
Headers show

Commit Message

Baruch Siach Jan. 25, 2014, 8:36 p.m. UTC 
Explicitly note the transfer_one and transfer_one_message are mutually
exclusive, to make the text a little more newcomers friendly.

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 include/linux/spi/spi.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Mark Brown Jan. 27, 2014, 6:44 p.m. UTC | #1 
On Sat, Jan 25, 2014 at 10:36:13PM +0200, Baruch Siach wrote:
> Explicitly note the transfer_one and transfer_one_message are mutually
> exclusive, to make the text a little more newcomers friendly.

Applied, thanks.  Still surprised this is confusing but hey ho.
diff mbox

Patch

diff --git a/include/linux/spi/spi.h b/include/linux/spi/spi.h
index 9f5242df9311..f5a08c3f3e60 100644
--- a/include/linux/spi/spi.h
+++ b/include/linux/spi/spi.h
@@ -287,7 +287,10 @@  static inline void spi_unregister_driver(struct spi_driver *sdrv)
  *                  - return 1 if the transfer is still in progress. When
  *                    the driver is finished with this transfer it must
  *                    call spi_finalize_current_transfer() so the subsystem
- *                    can issue the next transfer
+ *                    can issue the next transfer. Note: transfer_one and
+ *                    transfer_one_message are mutually exclusive; when both
+ *                    are set, the generic subsystem does not call your
+ *                    transfer_one callback.
  * @unprepare_message: undo any work done by prepare_message().
  * @cs_gpios: Array of GPIOs to use as chip select lines; one per CS
  *	number. Any individual value may be -ENOENT for CS lines that