summary refs log tree commit diff
path: root/Documentation/spi
diff options
context:
space:
mode:
authorAlexandru Ardelean <aardelean@deviqon.com>2021-03-08 16:55:02 +0200
committerMark Brown <broonie@kernel.org>2021-03-12 14:30:51 +0000
commit05d8a019eb057d14cdf9483318a7ee8b35a69cda (patch)
tree304d0324574626e80297b996b7266c291f335bef /Documentation/spi
parent3ab1cce553378fc0df1b1d26d7e23d03bd4dd3b6 (diff)
downloadlinux-05d8a019eb057d14cdf9483318a7ee8b35a69cda.tar.gz
spi: docs: update info about 'delay_usecs'
The 'delay_usecs' field is no longer present on the spi_transfer struct.
This change updates the doc to mention the usage of the (relatively) new
'delay' field.

Signed-off-by: Alexandru Ardelean <aardelean@deviqon.com>
Link: https://lore.kernel.org/r/20210308145502.1075689-11-aardelean@deviqon.com
Signed-off-by: Mark Brown <broonie@kernel.org>
Diffstat (limited to 'Documentation/spi')
-rw-r--r--Documentation/spi/spi-summary.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/spi/spi-summary.rst b/Documentation/spi/spi-summary.rst
index f1daffe10d78..d4239025461d 100644
--- a/Documentation/spi/spi-summary.rst
+++ b/Documentation/spi/spi-summary.rst
@@ -411,8 +411,11 @@ any more such messages.
         duplex (one pointer is NULL) transfers;
 
       + optionally defining short delays after transfers ... using
-        the spi_transfer.delay_usecs setting (this delay can be the
-        only protocol effect, if the buffer length is zero);
+        the spi_transfer.delay.value setting (this delay can be the
+        only protocol effect, if the buffer length is zero) ...
+        when specifying this delay the default spi_transfer.delay.unit
+        is microseconds, however this can be adjusted to clock cycles
+        or nanoseconds if needed;
 
       + whether the chipselect becomes inactive after a transfer and
         any delay ... by using the spi_transfer.cs_change flag;