[PATCH] spi: docs: Use the multi-lane mode constants in examples

[PATCH] spi: docs: Use the multi-lane mode constants in examples

[Karl Mehltretter]

The multi-lane documentation names SPI_MULTI_BUS_MODE_* constants,
including in the transfer initializers. The interface introduced with
the document uses SPI_MULTI_LANE_MODE_*, so the examples refer to
undefined macros.

Use the interface's constants in the descriptions and examples.

Fixes: 05c3bd745bb0 ("spi: Documentation: add page on multi-lane support")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 Documentation/spi/multiple-data-lanes.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/spi/multiple-data-lanes.rst b/Documentation/spi/multiple-data-lanes.rst
index 69cb532d052f..802aece35d56 100644
--- a/Documentation/spi/multiple-data-lanes.rst
+++ b/Documentation/spi/multiple-data-lanes.rst
@@ -127,7 +127,7 @@ field to indicate which mode they want to use for a given transfer.
 
 The possible values for this field have the following semantics:
 
-- :c:macro:`SPI_MULTI_BUS_MODE_SINGLE`: Only use the first lane. Other lanes are
+- :c:macro:`SPI_MULTI_LANE_MODE_SINGLE`: Only use the first lane. Other lanes are
     ignored. This means that it is operating just like a conventional SPI
     peripheral. This is the default, so it does not need to be explicitly set.
 
@@ -149,7 +149,7 @@ The possible values for this field have the following semantics:
         ----------   ----------------   ----------
             SDO 0    0-0-0-1-0-0-0-1    SDI 0
 
-- :c:macro:`SPI_MULTI_BUS_MODE_MIRROR`: Send a single data word over all of the
+- :c:macro:`SPI_MULTI_LANE_MODE_MIRROR`: Send a single data word over all of the
     lanes at the same time. This only makes sense for writes and not
     for reads.
 
@@ -160,7 +160,7 @@ The possible values for this field have the following semantics:
         struct spi_transfer xfer = {
             .tx_buf = tx_buf,
             .len = 1,
-            .multi_lane_mode = SPI_MULTI_BUS_MODE_MIRROR,
+            .multi_lane_mode = SPI_MULTI_LANE_MODE_MIRROR,
         };
 
         spi_sync_transfer(spi, &xfer, 1);
@@ -172,7 +172,7 @@ The possible values for this field have the following semantics:
             SDO 0    0-0-0-1-0-0-0-1    SDI 0
             SDO 1    0-0-0-1-0-0-0-1    SDI 1
 
-- :c:macro:`SPI_MULTI_BUS_MODE_STRIPE`: Send or receive two different data words
+- :c:macro:`SPI_MULTI_LANE_MODE_STRIPE`: Send or receive two different data words
     at the same time, one on each lane. This means that the buffer needs to be
     sized to hold data for all lanes. Data is interleaved in the buffer, with
     the first word corresponding to lane 0, the second to lane 1, and so on.
@@ -185,7 +185,7 @@ The possible values for this field have the following semantics:
         struct spi_transfer xfer = {
             .rx_buf = rx_buf,
             .len = 2,
-            .multi_lane_mode = SPI_MULTI_BUS_MODE_STRIPE,
+            .multi_lane_mode = SPI_MULTI_LANE_MODE_STRIPE,
         };
 
         spi_sync_transfer(spi, &xfer, 1);

base-commit: 50d05c7c76c96b90462f24debacca971d2e86713
-- 
2.39.5 (Apple Git-154)

Re: [PATCH] spi: docs: Use the multi-lane mode constants in examples

[Randy Dunlap]

On 9/9/26 8:32 PM, Karl Mehltretter wrote:
> The multi-lane documentation names SPI_MULTI_BUS_MODE_* constants,
> including in the transfer initializers. The interface introduced with
> the document uses SPI_MULTI_LANE_MODE_*, so the examples refer to
> undefined macros.
> 
> Use the interface's constants in the descriptions and examples.
> 
> Fixes: 05c3bd745bb0 ("spi: Documentation: add page on multi-lane support")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  Documentation/spi/multiple-data-lanes.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/spi/multiple-data-lanes.rst b/Documentation/spi/multiple-data-lanes.rst
> index 69cb532d052f..802aece35d56 100644
> --- a/Documentation/spi/multiple-data-lanes.rst
> +++ b/Documentation/spi/multiple-data-lanes.rst
> @@ -127,7 +127,7 @@ field to indicate which mode they want to use for a given transfer.
>  
>  The possible values for this field have the following semantics:
>  
> -- :c:macro:`SPI_MULTI_BUS_MODE_SINGLE`: Only use the first lane. Other lanes are
> +- :c:macro:`SPI_MULTI_LANE_MODE_SINGLE`: Only use the first lane. Other lanes are
>      ignored. This means that it is operating just like a conventional SPI
>      peripheral. This is the default, so it does not need to be explicitly set.
>  
> @@ -149,7 +149,7 @@ The possible values for this field have the following semantics:
>          ----------   ----------------   ----------
>              SDO 0    0-0-0-1-0-0-0-1    SDI 0
>  
> -- :c:macro:`SPI_MULTI_BUS_MODE_MIRROR`: Send a single data word over all of the
> +- :c:macro:`SPI_MULTI_LANE_MODE_MIRROR`: Send a single data word over all of the
>      lanes at the same time. This only makes sense for writes and not
>      for reads.
>  
> @@ -160,7 +160,7 @@ The possible values for this field have the following semantics:
>          struct spi_transfer xfer = {
>              .tx_buf = tx_buf,
>              .len = 1,
> -            .multi_lane_mode = SPI_MULTI_BUS_MODE_MIRROR,
> +            .multi_lane_mode = SPI_MULTI_LANE_MODE_MIRROR,
>          };
>  
>          spi_sync_transfer(spi, &xfer, 1);
> @@ -172,7 +172,7 @@ The possible values for this field have the following semantics:
>              SDO 0    0-0-0-1-0-0-0-1    SDI 0
>              SDO 1    0-0-0-1-0-0-0-1    SDI 1
>  
> -- :c:macro:`SPI_MULTI_BUS_MODE_STRIPE`: Send or receive two different data words
> +- :c:macro:`SPI_MULTI_LANE_MODE_STRIPE`: Send or receive two different data words
>      at the same time, one on each lane. This means that the buffer needs to be
>      sized to hold data for all lanes. Data is interleaved in the buffer, with
>      the first word corresponding to lane 0, the second to lane 1, and so on.
> @@ -185,7 +185,7 @@ The possible values for this field have the following semantics:
>          struct spi_transfer xfer = {
>              .rx_buf = rx_buf,
>              .len = 2,
> -            .multi_lane_mode = SPI_MULTI_BUS_MODE_STRIPE,
> +            .multi_lane_mode = SPI_MULTI_LANE_MODE_STRIPE,
>          };
>  
>          spi_sync_transfer(spi, &xfer, 1);
> 
> base-commit: 50d05c7c76c96b90462f24debacca971d2e86713

-- 
~Randy

Re: [PATCH] spi: docs: Use the multi-lane mode constants in examples

[Mark Brown]

On Thu, 10 Sep 2026 05:32:19 +0200, Karl Mehltretter wrote:
> spi: docs: Use the multi-lane mode constants in examples

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-7.4

Thanks!

[1/1] spi: docs: Use the multi-lane mode constants in examples
      https://git.kernel.org/broonie/spi/c/6ca4474f5a36

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark

Re: [PATCH] spi: docs: Use the multi-lane mode constants in examples

[David Lechner]

On 9/9/26 10:32 PM, Karl Mehltretter wrote:
> The multi-lane documentation names SPI_MULTI_BUS_MODE_* constants,
> including in the transfer initializers. The interface introduced with
> the document uses SPI_MULTI_LANE_MODE_*, so the examples refer to
> undefined macros.
> 
> Use the interface's constants in the descriptions and examples.
> 
> Fixes: 05c3bd745bb0 ("spi: Documentation: add page on multi-lane support")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
> ---
Thanks!

Reviewed-by: David Lechner <dlechner@baylibre.com>