Skip to contentSkip to conversation

HID: logitech-hidpp: BatteryVoltage: only read chargeStatus if extPower is active

PATCH In review Filipe Laíns 3 participants 4 messages Jan 11, 2020 – Jan 28, 2020

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

PATCH 1/1 HID: logitech-hidpp: BatteryVoltage: only read chargeStatus if extPower is active

In the HID++ 2.0 function getBatteryInfo() from the BatteryVoltage (0x1001) feature, chargeStatus is only valid if extPower is active.

Previously we were ignoring extPower, which resulted in wrong values.

Example:
With an unplugged mouse

$ cat /sys/class/power_supply/hidpp_battery_0/status Charging

This patch makes fixes that, it also renames charge_sts to flags as charge_sts can be confused with chargeStatus from the spec.

Spec:

+--------+-------------------------------------------------------------------------+
|  byte  |                                    2                                    |
+--------+--------------+------------+------------+----------+----------+----------+
|   bit  |     0..2     |      3     |      4     |     5    |     6    |     7    |
+--------+--------------+------------+------------+----------+----------+----------+
| buffer | chargeStatus | fastCharge | slowCharge | critical | (unused) | extPower |
+--------+--------------+------------+------------+----------+----------+----------+

Table 1 - battery voltage (0x1001), getBatteryInfo() (ASE 0), 3rd byte

+-------+--------------------------------------+
| value |                meaning               |
+-------+--------------------------------------+
|   0   | Charging                             |
+-------+--------------------------------------+
|   1   | End of charge (100% charged)         |
+-------+--------------------------------------+
|   2   | Charge stopped (any "normal" reason) |
+-------+--------------------------------------+
|   7   | Hardware error                       |
+-------+--------------------------------------+

Table 2 - chargeStatus value

---
 drivers/hid/hid-logitech-hidpp.c | 43 ++++++++++++++++----------------
 1 file changed, 21 insertions(+), 22 deletions(-)
drivers/hid/hid-logitech-hidpp.c +21 -22
index bb063e7d48df..39a5ee0aaab0 100644
@@ -1256,36 +1256,35 @@ static int hidpp20_battery_map_status_voltage(u8 data[3], int *voltage,
 {
 	int status;
 
-	long charge_sts = (long)data[2];
+	long flags = (long) data[2];
 
-	*level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
-	switch (data[2] & 0xe0) {
-	case 0x00:
-		status = POWER_SUPPLY_STATUS_CHARGING;
-		break;
-	case 0x20:
-		status = POWER_SUPPLY_STATUS_FULL;
-		*level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
-		break;
-	case 0x40:
+	if (flags & 0x80)
+		switch (flags & 0x07) {
+		case 0:
+			status = POWER_SUPPLY_STATUS_CHARGING;
+			break;
+		case 1:
+			status = POWER_SUPPLY_STATUS_FULL;
+			*level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
+			break;
+		case 2:
+			status = POWER_SUPPLY_STATUS_NOT_CHARGING;
+			break;
+		default:
+			status = POWER_SUPPLY_STATUS_UNKNOWN;
+			break;
+		}
+	else
 		status = POWER_SUPPLY_STATUS_DISCHARGING;
-		break;
-	case 0xe0:
-		status = POWER_SUPPLY_STATUS_NOT_CHARGING;
-		break;
-	default:
-		status = POWER_SUPPLY_STATUS_UNKNOWN;
-	}
 
 	*charge_type = POWER_SUPPLY_CHARGE_TYPE_STANDARD;
-	if (test_bit(3, &charge_sts)) {
+	if (test_bit(3, &flags)) {
 		*charge_type = POWER_SUPPLY_CHARGE_TYPE_FAST;
 	}
-	if (test_bit(4, &charge_sts)) {
+	if (test_bit(4, &flags)) {
 		*charge_type = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
 	}
-
-	if (test_bit(5, &charge_sts)) {
+	if (test_bit(5, &flags)) {
 		*level = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
 	}
 
Signature · 1 line
2.24.1
Tested-by Reviewed-by on v1 1/1
#1 lore raw
Quoted 4 lines · Filipe Laíns

In the HID++ 2.0 function getBatteryInfo() from the BatteryVoltage (0x1001) feature, chargeStatus is only valid if extPower is active.

Previously we were ignoring extPower, which resulted in wrong values.

Nice catch. Sorry for missing that the first time around.

Quoted 6 lines

Example:
With an unplugged mouse

$ cat /sys/class/power_supply/hidpp_battery_0/status Charging

Tested and it works as expected now.

Quoted 85 lines

This patch makes fixes that, it also renames charge_sts to flags as charge_sts can be confused with chargeStatus from the spec.

Spec:

+--------+-------------------------------------------------------------------------+
|  byte  |                                    2                                    |
+--------+--------------+------------+------------+----------+----------+----------+
|   bit  |     0..2     |      3     |      4     |     5    |     6    |     7    |
+--------+--------------+------------+------------+----------+----------+----------+
| buffer | chargeStatus | fastCharge | slowCharge | critical | (unused) | extPower |
+--------+--------------+------------+------------+----------+----------+----------+

Table 1 - battery voltage (0x1001), getBatteryInfo() (ASE 0), 3rd byte

+-------+--------------------------------------+
| value |                meaning               |
+-------+--------------------------------------+
|   0   | Charging                             |
+-------+--------------------------------------+
|   1   | End of charge (100% charged)         |
+-------+--------------------------------------+
|   2   | Charge stopped (any "normal" reason) |
+-------+--------------------------------------+
|   7   | Hardware error                       |
+-------+--------------------------------------+

Table 2 - chargeStatus value

---
  drivers/hid/hid-logitech-hidpp.c | 43 ++++++++++++++++----------------
  1 file changed, 21 insertions(+), 22 deletions(-)
drivers/hid/hid-logitech-hidpp.c +19 -19
index bb063e7d48df..39a5ee0aaab0 100644
@@ -1256,36 +1256,35 @@ static int hidpp20_battery_map_status_voltage(u8 data[3], int *voltage,
  {
  	int status;
 
-	long charge_sts = (long)data[2];
+	long flags = (long) data[2];
 
-	*level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
-	switch (data[2] & 0xe0) {
-	case 0x00:
-		status = POWER_SUPPLY_STATUS_CHARGING;
-		break;
-	case 0x20:
-		status = POWER_SUPPLY_STATUS_FULL;
-		*level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
-		break;
-	case 0x40:
+	if (flags & 0x80)
+		switch (flags & 0x07) {
+		case 0:
+			status = POWER_SUPPLY_STATUS_CHARGING;
+			break;
+		case 1:
+			status = POWER_SUPPLY_STATUS_FULL;
+			*level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
+			break;
+		case 2:
+			status = POWER_SUPPLY_STATUS_NOT_CHARGING;
+			break;
+		default:
+			status = POWER_SUPPLY_STATUS_UNKNOWN;
+			break;
+		}
+	else
  		status = POWER_SUPPLY_STATUS_DISCHARGING;
-		break;
-	case 0xe0:
-		status = POWER_SUPPLY_STATUS_NOT_CHARGING;
-		break;
-	default:
-		status = POWER_SUPPLY_STATUS_UNKNOWN;
-	}
 
  	*charge_type = POWER_SUPPLY_CHARGE_TYPE_STANDARD;
-	if (test_bit(3, &charge_sts)) {
+	if (test_bit(3, &flags)) {
  		*charge_type = POWER_SUPPLY_CHARGE_TYPE_FAST;
  	}

drivers/hid/hid-logitech-hidpp.c static int hidpp20_battery_map_status_voltage(u8 data[3], int *voltage, · line 1290

Quoted 10 lines
drivers/hid/hid-logitech-hidpp.c +2 -3
-	if (test_bit(4, &charge_sts)) {
+	if (test_bit(4, &flags)) {
  		*charge_type = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
  	}
-
-	if (test_bit(5, &charge_sts)) {
+	if (test_bit(5, &flags)) {
  		*level = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
  	}
 
#2 lore raw

Hi,

Quoted 10 lines · Pedro Vanzella
Quoted 4 lines · Filipe Laíns

In the HID++ 2.0 function getBatteryInfo() from the BatteryVoltage (0x1001) feature, chargeStatus is only valid if extPower is active.

Previously we were ignoring extPower, which resulted in wrong values.

Nice catch. Sorry for missing that the first time around.

Quoted 1 line
Quoted 7 lines
Quoted 5 lines

Example:
With an unplugged mouse

$ cat /sys/class/power_supply/hidpp_battery_0/status Charging

Tested and it works as expected now.

Thanks for the patch and the tests.

Unfortunately, the merge window is already opened, and I'd rather not sneak this one right now. This patch doesn't seem very critical so I rather not annoy the other maintainers.
I'll make sure it gets in the 5.6 final by pushing it into a rc when things are calmer for everybody.

So the plan would be:
- wait for the 'normal' 5.6 HID pull request to be sent
- apply this one in for-5.6/upstream-fixes
- sent this branch for either 5.6-rc1 or 5.6-rc2

Cheers,
Benjamin

Quoted 100 lines
Quoted 86 lines

This patch makes fixes that, it also renames charge_sts to flags as charge_sts can be confused with chargeStatus from the spec.

Spec:

+--------+-------------------------------------------------------------------------+
|  byte  |                                    2                                    |
+--------+--------------+------------+------------+----------+----------+----------+
|   bit  |     0..2     |      3     |      4     |     5    |     6    |     7    |
+--------+--------------+------------+------------+----------+----------+----------+
| buffer | chargeStatus | fastCharge | slowCharge | critical | (unused) | extPower |
+--------+--------------+------------+------------+----------+----------+----------+

Table 1 - battery voltage (0x1001), getBatteryInfo() (ASE 0), 3rd byte

+-------+--------------------------------------+
| value |                meaning               |
+-------+--------------------------------------+
|   0   | Charging                             |
+-------+--------------------------------------+
|   1   | End of charge (100% charged)         |
+-------+--------------------------------------+
|   2   | Charge stopped (any "normal" reason) |
+-------+--------------------------------------+
|   7   | Hardware error                       |
+-------+--------------------------------------+

Table 2 - chargeStatus value

---
  drivers/hid/hid-logitech-hidpp.c | 43 ++++++++++++++++----------------
  1 file changed, 21 insertions(+), 22 deletions(-)
drivers/hid/hid-logitech-hidpp.c +19 -19
index bb063e7d48df..39a5ee0aaab0 100644
@@ -1256,36 +1256,35 @@ static int hidpp20_battery_map_status_voltage(u8 data[3], int *voltage,
  {
      int status;
 
-     long charge_sts = (long)data[2];
+     long flags = (long) data[2];
 
-     *level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
-     switch (data[2] & 0xe0) {
-     case 0x00:
-             status = POWER_SUPPLY_STATUS_CHARGING;
-             break;
-     case 0x20:
-             status = POWER_SUPPLY_STATUS_FULL;
-             *level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
-             break;
-     case 0x40:
+     if (flags & 0x80)
+             switch (flags & 0x07) {
+             case 0:
+                     status = POWER_SUPPLY_STATUS_CHARGING;
+                     break;
+             case 1:
+                     status = POWER_SUPPLY_STATUS_FULL;
+                     *level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
+                     break;
+             case 2:
+                     status = POWER_SUPPLY_STATUS_NOT_CHARGING;
+                     break;
+             default:
+                     status = POWER_SUPPLY_STATUS_UNKNOWN;
+                     break;
+             }
+     else
              status = POWER_SUPPLY_STATUS_DISCHARGING;
-             break;
-     case 0xe0:
-             status = POWER_SUPPLY_STATUS_NOT_CHARGING;
-             break;
-     default:
-             status = POWER_SUPPLY_STATUS_UNKNOWN;
-     }
 
      *charge_type = POWER_SUPPLY_CHARGE_TYPE_STANDARD;
-     if (test_bit(3, &charge_sts)) {
+     if (test_bit(3, &flags)) {
              *charge_type = POWER_SUPPLY_CHARGE_TYPE_FAST;
      }

drivers/hid/hid-logitech-hidpp.c static int hidpp20_battery_map_status_voltage(u8 data[3], int *voltage, · line 1290

Quoted 10 lines
drivers/hid/hid-logitech-hidpp.c +2 -3
-     if (test_bit(4, &charge_sts)) {
+     if (test_bit(4, &flags)) {
              *charge_type = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
      }
-
-     if (test_bit(5, &charge_sts)) {
+     if (test_bit(5, &flags)) {
              *level = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
      }
 
#3 lore raw
Quoted 30 lines · Benjamin Tissoires

Hi,

Quoted 10 lines · Pedro Vanzella
Quoted 4 lines · Filipe Laíns

In the HID++ 2.0 function getBatteryInfo() from the BatteryVoltage (0x1001) feature, chargeStatus is only valid if extPower is active.

Previously we were ignoring extPower, which resulted in wrong values.

Nice catch. Sorry for missing that the first time around.

Quoted 1 line
Quoted 7 lines
Quoted 5 lines

Example:
With an unplugged mouse

$ cat /sys/class/power_supply/hidpp_battery_0/status Charging

Tested and it works as expected now.

Thanks for the patch and the tests.

Unfortunately, the merge window is already opened, and I'd rather not sneak this one right now. This patch doesn't seem very critical so I rather not annoy the other maintainers.
I'll make sure it gets in the 5.6 final by pushing it into a rc when things are calmer for everybody.

Quoted 11 lines

So the plan would be:
- wait for the 'normal' 5.6 HID pull request to be sent
- apply this one in for-5.6/upstream-fixes
- sent this branch for either 5.6-rc1 or 5.6-rc2

Cheers,
Benjamin

Quoted 3 lines
Quoted 3 lines

This patch makes fixes that, it also renames charge_sts to flags as

Fixed the typo: 's/makes //' and pushed to for-5.6/upstream-fixes

Cheers,
Benjamin

Quoted 97 lines
Quoted 97 lines
Quoted 83 lines

charge_sts can be confused with chargeStatus from the spec.

Spec:

+--------+-------------------------------------------------------------------------+
|  byte  |                                    2                                    |
+--------+--------------+------------+------------+----------+----------+----------+
|   bit  |     0..2     |      3     |      4     |     5    |     6    |     7    |
+--------+--------------+------------+------------+----------+----------+----------+
| buffer | chargeStatus | fastCharge | slowCharge | critical | (unused) | extPower |
+--------+--------------+------------+------------+----------+----------+----------+

Table 1 - battery voltage (0x1001), getBatteryInfo() (ASE 0), 3rd byte

+-------+--------------------------------------+
| value |                meaning               |
+-------+--------------------------------------+
|   0   | Charging                             |
+-------+--------------------------------------+
|   1   | End of charge (100% charged)         |
+-------+--------------------------------------+
|   2   | Charge stopped (any "normal" reason) |
+-------+--------------------------------------+
|   7   | Hardware error                       |
+-------+--------------------------------------+

Table 2 - chargeStatus value

---
  drivers/hid/hid-logitech-hidpp.c | 43 ++++++++++++++++----------------
  1 file changed, 21 insertions(+), 22 deletions(-)
drivers/hid/hid-logitech-hidpp.c +19 -19
index bb063e7d48df..39a5ee0aaab0 100644
@@ -1256,36 +1256,35 @@ static int hidpp20_battery_map_status_voltage(u8 data[3], int *voltage,
  {
      int status;
 
-     long charge_sts = (long)data[2];
+     long flags = (long) data[2];
 
-     *level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
-     switch (data[2] & 0xe0) {
-     case 0x00:
-             status = POWER_SUPPLY_STATUS_CHARGING;
-             break;
-     case 0x20:
-             status = POWER_SUPPLY_STATUS_FULL;
-             *level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
-             break;
-     case 0x40:
+     if (flags & 0x80)
+             switch (flags & 0x07) {
+             case 0:
+                     status = POWER_SUPPLY_STATUS_CHARGING;
+                     break;
+             case 1:
+                     status = POWER_SUPPLY_STATUS_FULL;
+                     *level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
+                     break;
+             case 2:
+                     status = POWER_SUPPLY_STATUS_NOT_CHARGING;
+                     break;
+             default:
+                     status = POWER_SUPPLY_STATUS_UNKNOWN;
+                     break;
+             }
+     else
              status = POWER_SUPPLY_STATUS_DISCHARGING;
-             break;
-     case 0xe0:
-             status = POWER_SUPPLY_STATUS_NOT_CHARGING;
-             break;
-     default:
-             status = POWER_SUPPLY_STATUS_UNKNOWN;
-     }
 
      *charge_type = POWER_SUPPLY_CHARGE_TYPE_STANDARD;
-     if (test_bit(3, &charge_sts)) {
+     if (test_bit(3, &flags)) {
              *charge_type = POWER_SUPPLY_CHARGE_TYPE_FAST;
      }

drivers/hid/hid-logitech-hidpp.c static int hidpp20_battery_map_status_voltage(u8 data[3], int *voltage, · line 1290

Quoted 10 lines
drivers/hid/hid-logitech-hidpp.c +2 -3
-     if (test_bit(4, &charge_sts)) {
+     if (test_bit(4, &flags)) {
              *charge_type = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
      }
-
-     if (test_bit(5, &charge_sts)) {
+     if (test_bit(5, &flags)) {
              *level = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
      }