[PATCH] ASoC: sti: uniperif: fix the undefined bitwise shift behavior problem

From: Su Hui
Date: Mon Mar 25 2024 - 09:16:38 EST


Clang static checker(scan-build):
sound/soc/sti/uniperif_player.c:1115:12: warning:
The result of the left shift is undefined because the right operand is
negative [core.UndefinedBinaryOperatorResult]

When UNIPERIF_CONFIG_BACK_STALL_REQ_SHIFT(ip) equals to -1, the result of
SET_UNIPERIF_CONFIG_BACK_STALL_REQ_DISABLE(ip) is undefined.

Here are some results of using different compilers.
1UL >> -1 1UL << -1
gcc 10.2.1 0x2 0
gcc 11.4.0 0 0x8000000000000000
clang 14.0.0 0x64b8a45d72a0 0x64b8a45d72a0
clang 17.0.0 0x556c43b0f2a0 0x556c43b0f2a0

Add some macros to ensure that when right opreand is negative or other
invalid values, the results of bitwise shift is zero.

Fixes: e1ecace6a685 ("ASoC: sti: Add uniperipheral header file")
Signed-off-by: Su Hui <suhui@xxxxxxxxxxxx>
---
sound/soc/sti/uniperif.h | 17 ++++++++++++++---
1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/sound/soc/sti/uniperif.h b/sound/soc/sti/uniperif.h
index 2a5de328501c..1cbff01fbff0 100644
--- a/sound/soc/sti/uniperif.h
+++ b/sound/soc/sti/uniperif.h
@@ -12,17 +12,28 @@

#include <sound/dmaengine_pcm.h>

+#define SR_SHIFT(a, b) ({unsigned long __a = (a); \
+ unsigned int __b = (b); \
+ __b < BITS_PER_LONG ? \
+ __a >> __b : 0; })
+
+#define SL_SHIFT(a, b) ({unsigned long __a = (a); \
+ unsigned int __b = (b); \
+ __b < BITS_PER_LONG ? \
+ __a << __b : 0; })
+
/*
* Register access macros
*/

#define GET_UNIPERIF_REG(ip, offset, shift, mask) \
- ((readl_relaxed(ip->base + offset) >> shift) & mask)
+ (SR_SHIFT(readl_relaxed(ip->base + offset), shift) & mask)
#define SET_UNIPERIF_REG(ip, offset, shift, mask, value) \
writel_relaxed(((readl_relaxed(ip->base + offset) & \
- ~(mask << shift)) | (((value) & mask) << shift)), ip->base + offset)
+ ~SL_SHIFT(mask, shift)) | SL_SHIFT(((value) & mask), shift)),\
+ ip->base + offset)
#define SET_UNIPERIF_BIT_REG(ip, offset, shift, mask, value) \
- writel_relaxed((((value) & mask) << shift), ip->base + offset)
+ writel_relaxed(SL_SHIFT(((value) & mask), shift), ip->base + offset)

/*
* UNIPERIF_SOFT_RST reg
--
2.30.2