Skip to contentSkip to conversation

nvmem: core: Fix msb clearing bits

PATCH In review Shadab Naseem 2 participants 3 messages Jan 31, 2020 – Feb 25, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 nvmem: core: Fix msb clearing bits

When clearing the msb bits of the resultant buffer, it is masked with the modulo of the number of bits needed with respect to the BITS_PER_BYTE. To mask out the buffer, it is passed though GENMASK of the remainder of the bits starting from zeroth bit. This case is valid if nbits is not a multiple of BITS_PER_BYTE and you are actually creating a GENMASK. If the nbits coming is a multiple of BITS_PER_BYTE, it would pass a negative value to the high bit number of GENMASK with zero as the lower bit number.

As per the definition of the GENMASK, the higher bit number (h) is right operand for bitwise right shift. If the value of the right operand is negative or is greater or equal to the number of bits in the promoted left operand, the behavior is undefined. So passing a negative value to GENMASK could behave differently across architecture, specifically between 64 and 32 bit. Also, on passing the hard-coded negative value as GENMASK(-1, 0) is giving compiler warning for shift-count-overflow. Hence making a check for clearing the MSB if the nbits are not a multiple of BITS_PER_BYTE.

---
 drivers/nvmem/core.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/nvmem/core.c +2 -1
index 1e4a798..23c1547 100644
@@ -926,7 +926,8 @@ static void nvmem_shift_read_buffer_in_place(struct nvmem_cell *cell, void *buf)
 		*p-- = 0;
 
 	/* clear msb bits if any leftover in the last byte */
-	*p &= GENMASK((cell->nbits%BITS_PER_BYTE) - 1, 0);
+	if (cell->nbits%BITS_PER_BYTE)
+		*p &= GENMASK((cell->nbits%BITS_PER_BYTE) - 1, 0);
 }
 
 static int __nvmem_cell_read(struct nvmem_device *nvmem,
Signature · 2 lines
QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a
member of the Code Aurora Forum, hosted by The Linux Foundation
Reviewed-by on v1 1/1
#1 lore raw
Quoted 31 lines · Shadab Naseem

When clearing the msb bits of the resultant buffer, it is masked with the modulo of the number of bits needed with respect to the BITS_PER_BYTE. To mask out the buffer, it is passed though GENMASK of the remainder of the bits starting from zeroth bit. This case is valid if nbits is not a multiple of BITS_PER_BYTE and you are actually creating a GENMASK. If the nbits coming is a multiple of BITS_PER_BYTE, it would pass a negative value to the high bit number of GENMASK with zero as the lower bit number.

As per the definition of the GENMASK, the higher bit number (h) is right operand for bitwise right shift. If the value of the right operand is negative or is greater or equal to the number of bits in the promoted left operand, the behavior is undefined. So passing a negative value to GENMASK could behave differently across architecture, specifically between 64 and 32 bit. Also, on passing the hard-coded negative value as GENMASK(-1, 0) is giving compiler warning for shift-count-overflow. Hence making a check for clearing the MSB if the nbits are not a multiple of BITS_PER_BYTE.

---
  drivers/nvmem/core.c | 3 ++-
  1 file changed, 2 insertions(+), 1 deletion(-)
drivers/nvmem/core.c +0 -0
index 1e4a798..23c1547 100644

drivers/nvmem/core.c static void nvmem_shift_read_buffer_in_place(struct nvmem_cell *cell, void *buf) · line 930

Quoted 6 lines
drivers/nvmem/core.c +2 -1
@@ -926,7 +926,8 @@ static void nvmem_shift_read_buffer_in_place(struct nvmem_cell *cell, void *buf)
  		*p-- = 0;
 
  	/* clear msb bits if any leftover in the last byte */
-	*p &= GENMASK((cell->nbits%BITS_PER_BYTE) - 1, 0);
+	if (cell->nbits%BITS_PER_BYTE)
+		*p &= GENMASK((cell->nbits%BITS_PER_BYTE) - 1, 0);

LGTM..

Reviewed-by [email protected]

Thanks
Mukesh

Quoted 3 lines
drivers/nvmem/core.c +0 -0
  }
 
  static int __nvmem_cell_read(struct nvmem_device *nvmem,
#2 lore raw

Gentle reminder as it is easily reproducible in 32 bit targets.

Regards

-Shadab

Quoted 51 lines · Mukesh Ojha
Quoted 31 lines · Shadab Naseem

When clearing the msb bits of the resultant buffer, it is masked with the modulo of the number of bits needed with respect to the BITS_PER_BYTE. To mask out the buffer, it is passed though GENMASK of the remainder of the bits starting from zeroth bit. This case is valid if nbits is not a multiple of BITS_PER_BYTE and you are actually creating a GENMASK. If the nbits coming is a multiple of BITS_PER_BYTE, it would pass a negative value to the high bit number of GENMASK with zero as the lower bit number.

As per the definition of the GENMASK, the higher bit number (h) is right operand for bitwise right shift. If the value of the right operand is negative or is greater or equal to the number of bits in the promoted left operand, the behavior is undefined. So passing a negative value to GENMASK could behave differently across architecture, specifically between 64 and 32 bit. Also, on passing the hard-coded negative value as GENMASK(-1, 0) is giving compiler warning for shift-count-overflow. Hence making a check for clearing the MSB if the nbits are not a multiple of BITS_PER_BYTE.

---
  drivers/nvmem/core.c | 3 ++-

  1 file changed, 2 insertions(+), 1 deletion(-)
drivers/nvmem/core.c +0 -0
index 1e4a798..23c1547 100644

drivers/nvmem/core.c static void · line 930

Quoted 6 lines
drivers/nvmem/core.c +2 -1
@@ -926,7 +926,8 @@ static void 
 nvmem_shift_read_buffer_in_place(struct nvmem_cell *cell, void *buf)
           *p-- = 0;
         /* clear msb bits if any leftover in the last byte */
-    *p &= GENMASK((cell->nbits%BITS_PER_BYTE) - 1, 0);
+    if (cell->nbits%BITS_PER_BYTE)
+        *p &= GENMASK((cell->nbits%BITS_PER_BYTE) - 1, 0);

LGTM..

Reviewed-by [email protected]

Thanks
Mukesh

Quoted 2 lines
drivers/nvmem/core.c +0 -0
   }
     static int __nvmem_cell_read(struct nvmem_device *nvmem,