diff options
| author | Baruch Siach <baruch@tkos.co.il> | 2014-01-25 15:36:13 -0500 |
|---|---|---|
| committer | Mark Brown <broonie@linaro.org> | 2014-01-27 13:43:36 -0500 |
| commit | 6e5f52674ff0756e61a8879f6232b9ac33735cba (patch) | |
| tree | a9e9c23ca06b64513fdd45878bbe0e54f03abd30 /include/linux/spi | |
| parent | 8b8b773e6b611e6629ac01f85d401c949d153546 (diff) | |
spi: spi.h: clarify the documentation of transfer_one
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>
Signed-off-by: Mark Brown <broonie@linaro.org>
Diffstat (limited to 'include/linux/spi')
| -rw-r--r-- | include/linux/spi/spi.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/include/linux/spi/spi.h b/include/linux/spi/spi.h index a1d4ca290862..ad050f0dd39d 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) | |||
| 287 | * - return 1 if the transfer is still in progress. When | 287 | * - return 1 if the transfer is still in progress. When |
| 288 | * the driver is finished with this transfer it must | 288 | * the driver is finished with this transfer it must |
| 289 | * call spi_finalize_current_transfer() so the subsystem | 289 | * call spi_finalize_current_transfer() so the subsystem |
| 290 | * can issue the next transfer | 290 | * can issue the next transfer. Note: transfer_one and |
| 291 | * transfer_one_message are mutually exclusive; when both | ||
| 292 | * are set, the generic subsystem does not call your | ||
| 293 | * transfer_one callback. | ||
| 291 | * @unprepare_message: undo any work done by prepare_message(). | 294 | * @unprepare_message: undo any work done by prepare_message(). |
| 292 | * @cs_gpios: Array of GPIOs to use as chip select lines; one per CS | 295 | * @cs_gpios: Array of GPIOs to use as chip select lines; one per CS |
| 293 | * number. Any individual value may be -ENOENT for CS lines that | 296 | * number. Any individual value may be -ENOENT for CS lines that |
