Skip to contentSkip to conversation

spi: Introduce and use spi_bpw_to_bytes()

PATCH Superseded Andy Shevchenko 2 participants 5 messages Apr 17, 2025 SPI

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover spi: Introduce and use spi_bpw_to_bytes()

Recently in the discussion with David the idea of having a common helper popped up. The helper converts the given bits per word to bytes. The result will always be power-of-two (e.g. for 37 bits it returns 8 bytes) or 0 for 0 input. More details are in the respective code comment.

This mini-series introduces it and replaces current users under drivers/spi and we expect more (and possibly some lurking in other subsystems).

Mark, if you okay with the idea, please, make this to be an immutable branch or tag for others to pull.

In v2:
- improved examples in the code comment and commit message (David)

Andy Shevchenko (2):
spi: Add spi_bpw_to_bytes() helper and use it
spi: dw: Use spi_bpw_to_bytes() helper

 drivers/spi/spi-dw-core.c |  2 +-
 drivers/spi/spi.c         |  2 +-
 include/linux/spi/spi.h   | 25 +++++++++++++++++++++++++
 3 files changed, 27 insertions(+), 2 deletions(-)
Signature · 1 line
2.47.2
#1 lore raw

PATCH v2 1/2 spi: Add spi_bpw_to_bytes() helper and use it

This helper converts the given bits per word to bytes. The result will always be power-of-two, e.g.,

    ===============    =================
    Input (in bits)    Output (in bytes)
    ===============    =================
            0                   0
            5                   1
            9                   2
            2                   4
            3                   8
    ===============    =================

There are a couple of cases in SPI that are using the same approach and at least one more (in IIO) would benefit of it. Add a helper for everyone.

---
 drivers/spi/spi.c       |  2 +-
 include/linux/spi/spi.h | 25 +++++++++++++++++++++++++
 2 files changed, 26 insertions(+), 1 deletion(-)
drivers/spi/spi.c +1 -1
index b0e7702951fe..1bc0fdbb1bd7 100644
@@ -3800,7 +3800,7 @@ int spi_split_transfers_maxwords(struct spi_controller *ctlr,
 		size_t maxsize;
 		int ret;
 
-		maxsize = maxwords * roundup_pow_of_two(BITS_TO_BYTES(xfer->bits_per_word));
+		maxsize = maxwords * spi_bpw_to_bytes(xfer->bits_per_word);
 		if (xfer->len > maxsize) {
 			ret = __spi_split_transfer_maxsize(ctlr, msg, &xfer,
 							   maxsize);
include/linux/spi/spi.h +25 -0
index 834a09bd8ccc..2611f86180a3 100644
@@ -1340,6 +1340,31 @@ static inline bool spi_is_bpw_supported(struct spi_device *spi, u32 bpw)
 	return false;
 }
 
+/**
+ * spi_bpw_to_bytes - Covert bits per word to bytes
+ * @bpw: Bits per word
+ *
+ * This function converts the given @bpw to bytes. The result is always
+ * power-of-two, e.g.,
+ *
+ *  ===============    =================
+ *  Input (in bits)    Output (in bytes)
+ *  ===============    =================
+ *          0                   0
+ *          5                   1
+ *          9                   2
+ *          2                   4
+ *          3                   8
+ *  ===============    =================
+ *
+ * Returns:
+ * Bytes for the given @bpw.
+ */
+static inline u32 spi_bpw_to_bytes(u32 bpw)
+{
+	return roundup_pow_of_two(BITS_TO_BYTES(bpw));
+}
+
 /**
  * spi_controller_xfer_timeout - Compute a suitable timeout value
  * @ctlr: SPI device
Signature · 1 line
2.47.2
#2 lore raw

Re: [PATCH v2 1/2] spi: Add spi_bpw_to_bytes() helper and use it

Quoted 10 lines · Andy Shevchenko

This helper converts the given bits per word to bytes. The result will always be power-of-two, e.g.,

    ===============    =================
    Input (in bits)    Output (in bytes)
    ===============    =================
            0                   0
            5                   1
            9                   2
Quoted 2 lines

2 4
3 8

My gosh, it lost the couple of characters here, should be 21 and 37 respectively... I'll fix this in v3.

Quoted 1 line
    ===============    =================

...

Quoted 10 lines

+ * This function converts the given @bpw to bytes. The result is always
+ * power-of-two, e.g.,
+ *

+ *  ===============    =================
+ *  Input (in bits)    Output (in bytes)
+ *  ===============    =================
+ *          0                   0
+ *          5                   1
+ *          9                   2
Quoted 2 lines
+ *          2                   4
+ *          3                   8

As per above,

Quoted 1 line

+ * =============== =================

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#3 lore raw

PATCH v2 2/2 spi: dw: Use spi_bpw_to_bytes() helper

In reply to Andy Shevchenko

Use existing helper to get amount of bytes (as power-of-two value) from bits per word.

---
 drivers/spi/spi-dw-core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/spi/spi-dw-core.c +1 -1
index 941ecc6f59f8..b3b883cb9541 100644
@@ -423,7 +423,7 @@ static int dw_spi_transfer_one(struct spi_controller *host,
 	int ret;
 
 	dws->dma_mapped = 0;
-	dws->n_bytes = roundup_pow_of_two(BITS_TO_BYTES(transfer->bits_per_word));
+	dws->n_bytes = spi_bpw_to_bytes(transfer->bits_per_word);
 	dws->tx = (void *)transfer->tx_buf;
 	dws->tx_len = transfer->len / dws->n_bytes;
 	dws->rx = transfer->rx_buf;
Signature · 1 line
2.47.2
Reviewed-by on the v2 series
#4 lore raw
In reply to Andy Shevchenko
Quoted 10 lines · Andy Shevchenko

Recently in the discussion with David the idea of having a common helper popped up. The helper converts the given bits per word to bytes. The result will always be power-of-two (e.g. for 37 bits it returns 8 bytes) or 0 for 0 input. More details are in the respective code comment.

This mini-series introduces it and replaces current users under drivers/spi and we expect more (and possibly some lurking in other subsystems).

Quoted 5 lines

Mark, if you okay with the idea, please, make this to be an immutable branch or tag for others to pull.

In v2:
- improved examples in the code comment and commit message (David)

With the typos fixed: