diff mbox series

[v3,2/2] spi: dt-bindings: spi-controller: Fix spi-[rt]x-bus-width for slave mode

Message ID 20200306085038.8111-3-geert+renesas@glider.be (mailing list archive)
State Accepted
Commit 30b435d54b84fd1f9c53a237dec3c224ec1e59c7
Headers show
Series spi: dt-bindings: spi-controller: Slave mode fixes | expand

Commit Message

Geert Uytterhoeven March 6, 2020, 8:50 a.m. UTC
The descriptions for the spi-rx-bus-width and spi-tx-bus-width
properties refer to "MISO" and "MOSI", which are not explained in the
document.  While these abbreviations are fairly common when talking
about SPI, and thus may not need an explanation, they are not entirely
correct in this context, as the SPI controller may be used in slave mode
instead of master mode.

Fix this by replacing them by "read transfers" resp. "write transfers",
like is done for the spi-rx-delay-us and spi-tx-delay-us properties.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
v3:
  - No changes,

v2:
  - New.

This issue was present in the .txt version of the bindings, too, so
technically it needs
Fixes: a8830cb19cfea04e ("spi: Document DT bindings for SPI controllers in slave mode")
but of course it won't apply to that version.
---
 Documentation/devicetree/bindings/spi/spi-controller.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Rob Herring March 12, 2020, 7:17 p.m. UTC | #1
On Fri,  6 Mar 2020 09:50:38 +0100, Geert Uytterhoeven wrote:
> The descriptions for the spi-rx-bus-width and spi-tx-bus-width
> properties refer to "MISO" and "MOSI", which are not explained in the
> document.  While these abbreviations are fairly common when talking
> about SPI, and thus may not need an explanation, they are not entirely
> correct in this context, as the SPI controller may be used in slave mode
> instead of master mode.
> 
> Fix this by replacing them by "read transfers" resp. "write transfers",
> like is done for the spi-rx-delay-us and spi-tx-delay-us properties.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
> v3:
>   - No changes,
> 
> v2:
>   - New.
> 
> This issue was present in the .txt version of the bindings, too, so
> technically it needs
> Fixes: a8830cb19cfea04e ("spi: Document DT bindings for SPI controllers in slave mode")
> but of course it won't apply to that version.
> ---
>  Documentation/devicetree/bindings/spi/spi-controller.yaml | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 

Acked-by: Rob Herring <robh@kernel.org>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/spi/spi-controller.yaml b/Documentation/devicetree/bindings/spi/spi-controller.yaml
index 0ebaf6677ac4f68d..d8e5509a70816df5 100644
--- a/Documentation/devicetree/bindings/spi/spi-controller.yaml
+++ b/Documentation/devicetree/bindings/spi/spi-controller.yaml
@@ -120,7 +120,7 @@  patternProperties:
           - enum: [ 1, 2, 4, 8 ]
           - default: 1
         description:
-          Bus width to the SPI bus used for MISO.
+          Bus width to the SPI bus used for read transfers.
 
       spi-rx-delay-us:
         description:
@@ -132,7 +132,7 @@  patternProperties:
           - enum: [ 1, 2, 4, 8 ]
           - default: 1
         description:
-          Bus width to the SPI bus used for MOSI.
+          Bus width to the SPI bus used for write transfers.
 
       spi-tx-delay-us:
         description: