ASoC: cs35l41: Add one more variable in the debug log
Subsystems (3)
PATCH v2 1/2 ASoC: cs35l41: Add one more variable in the debug log
otp_map[].size is a key variable to compute the value of otp_val and to update the bit_offset, it is helpful to debug if could put it in the debug log.
--- sound/soc/codecs/cs35l41-lib.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
sound/soc/codecs/cs35l41-lib.c +2 -2
@@ -822,8 +822,8 @@ int cs35l41_otp_unpack(struct device *dev, struct regmap *regmap) word_offset = otp_map_match->word_offset;for (i =0 ; i < otp_map_match->num_elements; i++) { -dev_dbg (dev,"bitoffset= %d, word_offset=%d, bit_sum mod 32=%d\n" , - bit_offset, word_offset, bit_sum %32 ); +dev_dbg (dev,"bitoffset= %d, word_offset=%d, bit_sum mod 32=%d otp_map[i].size = %d\n" , + bit_offset, word_offset, bit_sum %32 , otp_map[i].size);if (bit_offset + otp_map[i].size -1 >=32 ) { otp_val = (otp_mem[word_offset] &GENMASK (31 , bit_offset)) >> bit_offset;
Signature · 1 line
2.25.1
PATCH v2 2/2 ASoC: cs35l41: Don't hard-code the number of otp_elem in the array
The CS35L41_NUM_OTP_ELEM is 100, but only 99 entries are defined in the array otp_map_1/2[CS35L41_NUM_OTP_ELEM], this will trigger UBSAN to report a shift-out-of-bounds warning in the cs35l41_otp_unpack() since the last entry in the array will resuilt in GENMASK(-1, 0).
To fix it, removing the definition CS35L41_NUM_OTP_ELEM and use ARRAY_SIZE to calculate the number of elements dynamically.
--- include/sound/cs35l41.h | 1 - sound/soc/codecs/cs35l41-lib.c | 14 +++++++------- 2 files changed, 7 insertions(+), 8 deletions(-)
include/sound/cs35l41.h +0 -1
@@ -536,7 +536,6 @@#define CS35L41_MAX_CACHE_REG 36#define CS35L41_OTP_SIZE_WORDS 32 -#define CS35L41_NUM_OTP_ELEM 100#define CS35L41_VALID_PDATA 0x80000000#define CS35L41_NUM_SUPPLIES 2
sound/soc/codecs/cs35l41-lib.c +7 -7
@@ -422,7 +422,7 @@ static bool cs35l41_volatile_reg(struct device *dev, unsigned int reg) } } -static const struct cs35l41_otp_packed_element_t otp_map_1[CS35L41_NUM_OTP_ELEM ] = { +static const struct cs35l41_otp_packed_element_t otp_map_1[] = {/* addr shift size */ {0x00002030 ,0 ,4 },/*TRIM_OSC_FREQ_TRIM*/ {0x00002030 ,7 ,1 },/*TRIM_OSC_TRIM_DONE*/
@@ -525,7 +525,7 @@ static const struct cs35l41_otp_packed_element_t otp_map_1[CS35L41_NUM_OTP_ELEM] { 0x00017044, 0, 24 }, /*LOT_NUMBER*/ }; -static const struct cs35l41_otp_packed_element_t otp_map_2[CS35L41_NUM_OTP_ELEM ] = { +static const struct cs35l41_otp_packed_element_t otp_map_2[] = {/* addr shift size */ {0x00002030 ,0 ,4 },/*TRIM_OSC_FREQ_TRIM*/ { 0x00002030, 7, 1 }, /*TRIM_OSC_TRIM_DONE*/
@@ -671,35 +671,35 @@ static const struct cs35l41_otp_map_element_t cs35l41_otp_map_map[] = { { .id = 0x01, .map = otp_map_1, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_1), .bit_offset = 16, .word_offset = 2, }, { .id = 0x02, .map = otp_map_2, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_2), .bit_offset = 16, .word_offset = 2, }, { .id = 0x03, .map = otp_map_2, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_2), .bit_offset = 16, .word_offset = 2, }, { .id = 0x06, .map = otp_map_2, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_2), .bit_offset = 16, .word_offset = 2, }, { .id = 0x08, .map = otp_map_1, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_1), .bit_offset = 16, .word_offset = 2, },
Signature · 1 line
2.25.1
Re: [PATCH v2 2/2] ASoC: cs35l41: Don't hard-code the number of otp_elem in the array
Quoted 4 lines · Hui Wang
The
CS35L41_NUM_OTP_ELEMis 100, but only 99 entries are defined in the array otp_map_1/2[CS35L41_NUM_OTP_ELEM], this will trigger UBSAN to report a shift-out-of-bounds warning in thecs35l41_otp_unpack()since the last entry in the array will resuilt inGENMASK(-1, 0).
result
Quoted 3 lines
To fix it, removing the definition
CS35L41_NUM_OTP_ELEMand useARRAY_SIZEto calculate the number of elements dynamically.
This a plain out-of-bounds access issue, you could just say that. And at the end, you could say that UBSAN reported the issue.
Also the title should start with Fix, like:
"Fix out-of-bounds access in cs35l41_otp_packed_element_t"
Quoted 1 line
Quoted 1 line
Signed-off-by Hui Wang <[email protected]>
You are missing the Fixes tag.
Quoted 80 lines
--- include/sound/cs35l41.h | 1 - sound/soc/codecs/cs35l41-lib.c | 14 +++++++------- 2 files changed, 7 insertions(+), 8 deletions(-)include/sound/cs35l41.h +0
-1@@ -536,7 +536,6 @@#define CS35L41_MAX_CACHE_REG 36#define CS35L41_OTP_SIZE_WORDS 32 -#define CS35L41_NUM_OTP_ELEM 100#define CS35L41_VALID_PDATA 0x80000000#define CS35L41_NUM_SUPPLIES 2sound/soc/codecs/cs35l41-lib.c +7
-7@@ -422,7 +422,7 @@ static bool cs35l41_volatile_reg(struct device *dev, unsigned int reg) } } -static const struct cs35l41_otp_packed_element_t otp_map_1[CS35L41_NUM_OTP_ELEM ] = { +static const struct cs35l41_otp_packed_element_t otp_map_1[] = {/* addr shift size */ {0x00002030 ,0 ,4 },/*TRIM_OSC_FREQ_TRIM*/ {0x00002030 ,7 ,1 },/*TRIM_OSC_TRIM_DONE*/ @@ -525,7 +525,7 @@ static const struct cs35l41_otp_packed_element_t otp_map_1[CS35L41_NUM_OTP_ELEM] { 0x00017044, 0, 24 }, /*LOT_NUMBER*/ }; -static const struct cs35l41_otp_packed_element_t otp_map_2[CS35L41_NUM_OTP_ELEM ] = { +static const struct cs35l41_otp_packed_element_t otp_map_2[] = {/* addr shift size */ {0x00002030 ,0 ,4 },/*TRIM_OSC_FREQ_TRIM*/ { 0x00002030, 7, 1 }, /*TRIM_OSC_TRIM_DONE*/@@ -671,35 +671,35 @@ static const struct cs35l41_otp_map_element_t cs35l41_otp_map_map[] = { { .id = 0x01, .map = otp_map_1, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_1), .bit_offset = 16, .word_offset = 2, }, { .id = 0x02, .map = otp_map_2, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_2), .bit_offset = 16, .word_offset = 2, }, { .id = 0x03, .map = otp_map_2, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_2), .bit_offset = 16, .word_offset = 2, }, { .id = 0x06, .map = otp_map_2, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_2), .bit_offset = 16, .word_offset = 2, }, { .id = 0x08, .map = otp_map_1, - .num_elements = CS35L41_NUM_OTP_ELEM, + .num_elements = ARRAY_SIZE(otp_map_1), .bit_offset = 16, .word_offset = 2, },
Re: [PATCH v2 2/2] ASoC: cs35l41: Don't hard-code the number of otp_elem in the array
Quoted 12 lines · Lucas tanure
Quoted 4 lines · Hui Wang
The
CS35L41_NUM_OTP_ELEMis 100, but only 99 entries are defined in the array otp_map_1/2[CS35L41_NUM_OTP_ELEM], this will trigger UBSAN to report a shift-out-of-bounds warning in thecs35l41_otp_unpack()since the last entry in the array will resuilt inGENMASK(-1, 0).result
Quoted 3 lines
To fix it, removing the definition
CS35L41_NUM_OTP_ELEMand useARRAY_SIZEto calculate the number of elements dynamically.This a plain out-of-bounds access issue, you could just say that. And at the end, you could say that UBSAN reported the issue.
Quoted 9 lines
Also the title should start with Fix, like:
"Fix out-of-bounds access incs35l41_otp_packed_element_t"Quoted 1 line
Fixes 6450ef559056 ("ASoC: cs35l41: CS35L41 Boosted Smart Amplifier")Quoted 1 line
Signed-off-by Hui Wang <[email protected]>You are missing the Fixes tag.
OK, got it, will address all comment.
Thanks.
Re: [PATCH v2 2/2] ASoC: cs35l41: Don't hard-code the number of otp_elem in the array
In reply to Hui WangQuoted 10 lines · Hui Wang
The
CS35L41_NUM_OTP_ELEMis 100, but only 99 entries are defined in the array otp_map_1/2[CS35L41_NUM_OTP_ELEM], this will trigger UBSAN to report a shift-out-of-bounds warning in thecs35l41_otp_unpack()since the last entry in the array will resuilt inGENMASK(-1, 0).To fix it, removing the definition
CS35L41_NUM_OTP_ELEMand useARRAY_SIZEto calculate the number of elements dynamically.Signed-off-by Hui Wang <[email protected]>---
Thanks,
Charles
Quoted 14 lines · Hui Wang
otp_map[].size is a key variable to compute the value of
otp_valand to update thebit_offset, it is helpful to debug if could put it in the debug log.Signed-off-by Hui Wang <[email protected]>--- sound/soc/codecs/cs35l41-lib.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)sound/soc/codecs/cs35l41-lib.c +0
-0
sound/soc/codecs/cs35l41-lib.c int cs35l41_otp_unpack(struct device *dev, struct regmap *regmap) · line 826
Quoted 7 lines
sound/soc/codecs/cs35l41-lib.c +2
-2@@ -822,8 +822,8 @@ int cs35l41_otp_unpack(struct device *dev, struct regmap *regmap) word_offset = otp_map_match->word_offset;for (i =0 ; i < otp_map_match->num_elements; i++) { -dev_dbg (dev,"bitoffset= %d, word_offset=%d, bit_sum mod 32=%d\n" , - bit_offset, word_offset, bit_sum %32 ); +dev_dbg (dev,"bitoffset= %d, word_offset=%d, bit_sum mod 32=%d otp_map[i].size = %d\n" , + bit_offset, word_offset, bit_sum %32 , otp_map[i].size);
otp_map[i].size is u8, please use %u to print it.
And add an "," between "bit_sum mod" and "otp_map[i].size" to keep consistency.
Quoted 3 lines
sound/soc/codecs/cs35l41-lib.c +0
-0if (bit_offset + otp_map[i].size -1 >=32 ) { otp_val = (otp_mem[word_offset] &GENMASK (31 , bit_offset)) >> bit_offset;