Battery (Windows): detect cycle count

CarterLi · CarterLi · commit f5b987dba937 · 2023-11-06T19:40:40.000+08:00
diff --git a/src/detection/battery/battery.h b/src/detection/battery/battery.h
@@ -15,7 +15,7 @@ typedef struct FFBatteryResult
     double capacity;
     FFstrbuf status;
     double temperature;
-    int32_t cycleCount;
+    uint32_t cycleCount;
 } FFBatteryResult;
 
 const char* ffDetectBattery(FFBatteryOptions* options, FFlist* results);
diff --git a/src/detection/battery/battery_android.c b/src/detection/battery/battery_android.c
@@ -35,6 +35,7 @@ static const char* parseTermuxApi(FFBatteryOptions* options, FFlist* results)
 
     FFBatteryResult* battery = ffListAdd(results);
     battery->temperature = FF_BATTERY_TEMP_UNSET;
+    battery->cycleCount = 0;
     ffStrbufInit(&battery->manufacturer);
     ffStrbufInit(&battery->modelName);
     ffStrbufInit(&battery->status);
diff --git a/src/detection/battery/battery_apple.c b/src/detection/battery/battery_apple.c
@@ -56,7 +56,7 @@ const char* ffDetectBattery(FFBatteryOptions* options, FFlist* results)
                 ffStrbufAppendS(&battery->modelName, "Built-in");
         }
 
-        ffCfDictGetInt(properties, CFSTR("CycleCount"), &battery->cycleCount);
+        ffCfDictGetInt(properties, CFSTR("CycleCount"), (int32_t*) &battery->cycleCount);
 
         if (!ffCfDictGetBool(properties, CFSTR("ExternalConnected"), &boolValue) && boolValue)
             ffStrbufAppendS(&battery->status, "AC connected, ");
diff --git a/src/detection/battery/battery_bsd.c b/src/detection/battery/battery_bsd.c
@@ -34,6 +34,7 @@ const char* ffDetectBattery(FF_MAYBE_UNUSED FFBatteryOptions* options, FFlist* r
 
         FFBatteryResult* battery = ffListAdd(results);
         battery->temperature = FF_BATTERY_TEMP_UNSET;
+        battery->cycleCount = 0;
         ffStrbufInit(&battery->manufacturer);
         ffStrbufInit(&battery->modelName);
         ffStrbufInit(&battery->status);
diff --git a/src/detection/battery/battery_linux.c b/src/detection/battery/battery_linux.c
@@ -69,7 +69,7 @@ static void parseBattery(FFstrbuf* dir, const char* id, FFBatteryOptions* option
     ffReadFileBuffer(dir->chars, &testBatteryBuffer);
     ffStrbufSubstrBefore(dir, dirLength);
     if(dir->length)
-        result->cycleCount = (int32_t) ffStrbufToUInt(&testBatteryBuffer, 0);
+        result->cycleCount = (uint32_t) ffStrbufToUInt(&testBatteryBuffer, 0);
 
     result->temperature = FF_BATTERY_TEMP_UNSET;
     if (options->temp)
diff --git a/src/detection/battery/battery_windows.c b/src/detection/battery/battery_windows.c
@@ -30,137 +30,146 @@ static inline void wrapSetupDiDestroyDeviceInfoList(HDEVINFO* hdev)
         SetupDiDestroyDeviceInfoList(*hdev);
 }
 
-const char* ffDetectBattery(FFBatteryOptions* options, FFlist* results)
+static const char* detectWithSetupApi(FFBatteryOptions* options, FFlist* results)
 {
-    if(options->useSetupApi)
+    //https://learn.microsoft.com/en-us/windows/win32/power/enumerating-battery-devices
+    HDEVINFO hdev __attribute__((__cleanup__(wrapSetupDiDestroyDeviceInfoList))) =
+        SetupDiGetClassDevsW(&GUID_DEVCLASS_BATTERY, 0, 0, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
+    if(hdev == INVALID_HANDLE_VALUE)
+        return "SetupDiGetClassDevsW(&GUID_DEVCLASS_BATTERY) failed";
+
+    SP_DEVICE_INTERFACE_DATA did = { .cbSize = sizeof(did) };
+    for(DWORD idev = 0; SetupDiEnumDeviceInterfaces(hdev, NULL, &GUID_DEVCLASS_BATTERY, idev, &did); idev++)
     {
-        //https://learn.microsoft.com/en-us/windows/win32/power/enumerating-battery-devices
-        HDEVINFO hdev __attribute__((__cleanup__(wrapSetupDiDestroyDeviceInfoList))) =
-            SetupDiGetClassDevsW(&GUID_DEVCLASS_BATTERY, 0, 0, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
-        if(hdev == INVALID_HANDLE_VALUE)
-            return "SetupDiGetClassDevsW(&GUID_DEVCLASS_BATTERY) failed";
-
-        SP_DEVICE_INTERFACE_DATA did = { .cbSize = sizeof(did) };
-        for(DWORD idev = 0; SetupDiEnumDeviceInterfaces(hdev, NULL, &GUID_DEVCLASS_BATTERY, idev, &did); idev++)
+        DWORD cbRequired = 0;
+        SetupDiGetDeviceInterfaceDetailW(hdev, &did, NULL, 0, &cbRequired, NULL); //Fail with not enough buffer
+        SP_DEVICE_INTERFACE_DETAIL_DATA_W* FF_AUTO_FREE pdidd = (SP_DEVICE_INTERFACE_DETAIL_DATA_W*)malloc(cbRequired);
+        if(!pdidd)
+            break; //Out of memory
+
+        pdidd->cbSize = sizeof(*pdidd);
+        if(!SetupDiGetDeviceInterfaceDetailW(hdev, &did, pdidd, cbRequired, &cbRequired, NULL))
+            continue;
+
+        HANDLE __attribute__((__cleanup__(wrapCloseHandle))) hBattery =
+            CreateFileW(pdidd->DevicePath, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
+
+        if(hBattery == INVALID_HANDLE_VALUE)
+            continue;
+
+        BATTERY_QUERY_INFORMATION bqi = { .InformationLevel = BatteryInformation };
+
+        DWORD dwWait = 0;
+        DWORD dwOut;
+
+        if(!DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_TAG, &dwWait, sizeof(dwWait), &bqi.BatteryTag, sizeof(bqi.BatteryTag), &dwOut, NULL) && bqi.BatteryTag)
+            continue;
+
+        BATTERY_INFORMATION bi = {0};
+        if(!DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_INFORMATION, &bqi, sizeof(bqi), &bi, sizeof(bi), &dwOut, NULL))
+            continue;
+
+        if(!(bi.Capabilities & BATTERY_SYSTEM_BATTERY))
+            continue;
+
+        FFBatteryResult* battery = (FFBatteryResult*)ffListAdd(results);
+
+        if(memcmp(bi.Chemistry, "PbAc", 4) == 0)
+            ffStrbufInitS(&battery->technology, "Lead Acid");
+        else if(memcmp(bi.Chemistry, "LION", 4) == 0 || memcmp(bi.Chemistry, "Li-I", 4) == 0)
+            ffStrbufInitS(&battery->technology, "Lithium Ion");
+        else if(memcmp(bi.Chemistry, "NiCd", 4) == 0)
+            ffStrbufInitS(&battery->technology, "Nickel Cadmium");
+        else if(memcmp(bi.Chemistry, "NiMH", 4) == 0)
+            ffStrbufInitS(&battery->technology, "Nickel Metal Hydride");
+        else if(memcmp(bi.Chemistry, "NiZn", 4) == 0)
+            ffStrbufInitS(&battery->technology, "Nickel Zinc");
+        else if(memcmp(bi.Chemistry, "RAM\0", 4) == 0)
+            ffStrbufInitS(&battery->technology, "Rechargeable Alkaline-Manganese");
+        else
+            ffStrbufInitS(&battery->technology, "Unknown");
+
+        {
+            ffStrbufInit(&battery->modelName);
+            bqi.InformationLevel = BatteryDeviceName;
+            wchar_t name[64];
+            if(DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_INFORMATION, &bqi, sizeof(bqi), name, sizeof(name), &dwOut, NULL))
+                ffStrbufSetWS(&battery->modelName, name);
+        }
+
+        {
+            ffStrbufInit(&battery->manufacturer);
+            bqi.InformationLevel = BatteryManufactureName;
+            wchar_t name[64];
+            if(DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_INFORMATION, &bqi, sizeof(bqi), name, sizeof(name), &dwOut, NULL))
+                ffStrbufSetWS(&battery->manufacturer, name);
+        }
+
+        battery->cycleCount = bi.CycleCount;
+
+        battery->temperature = 0.0/0.0;
+        if(options->temp)
+        {
+            bqi.InformationLevel = BatteryTemperature;
+            ULONG temp;
+            if(DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_INFORMATION, &bqi, sizeof(bqi), &temp, sizeof(temp), &dwOut, NULL))
+                battery->temperature = temp;
+        }
+
         {
-            DWORD cbRequired = 0;
-            SetupDiGetDeviceInterfaceDetailW(hdev, &did, NULL, 0, &cbRequired, NULL); //Fail with not enough buffer
-            SP_DEVICE_INTERFACE_DETAIL_DATA_W* FF_AUTO_FREE pdidd = (SP_DEVICE_INTERFACE_DETAIL_DATA_W*)malloc(cbRequired);
-            if(!pdidd)
-                break; //Out of memory
-
-            pdidd->cbSize = sizeof(*pdidd);
-            if(!SetupDiGetDeviceInterfaceDetailW(hdev, &did, pdidd, cbRequired, &cbRequired, NULL))
-                continue;
-
-            HANDLE __attribute__((__cleanup__(wrapCloseHandle))) hBattery =
-                CreateFileW(pdidd->DevicePath, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
-
-            if(hBattery == INVALID_HANDLE_VALUE)
-                continue;
-
-            BATTERY_QUERY_INFORMATION bqi = { .InformationLevel = BatteryInformation };
-
-            DWORD dwWait = 0;
-            DWORD dwOut;
-
-            if(!DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_TAG, &dwWait, sizeof(dwWait), &bqi.BatteryTag, sizeof(bqi.BatteryTag), &dwOut, NULL) && bqi.BatteryTag)
-                continue;
-
-            BATTERY_INFORMATION bi = {0};
-            if(!DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_INFORMATION, &bqi, sizeof(bqi), &bi, sizeof(bi), &dwOut, NULL))
-                continue;
-
-            if(!(bi.Capabilities & BATTERY_SYSTEM_BATTERY))
-                continue;
-
-            FFBatteryResult* battery = (FFBatteryResult*)ffListAdd(results);
-
-            if(memcmp(bi.Chemistry, "PbAc", 4) == 0)
-                ffStrbufInitS(&battery->technology, "Lead Acid");
-            else if(memcmp(bi.Chemistry, "LION", 4) == 0 || memcmp(bi.Chemistry, "Li-I", 4) == 0)
-                ffStrbufInitS(&battery->technology, "Lithium Ion");
-            else if(memcmp(bi.Chemistry, "NiCd", 4) == 0)
-                ffStrbufInitS(&battery->technology, "Nickel Cadmium");
-            else if(memcmp(bi.Chemistry, "NiMH", 4) == 0)
-                ffStrbufInitS(&battery->technology, "Nickel Metal Hydride");
-            else if(memcmp(bi.Chemistry, "NiZn", 4) == 0)
-                ffStrbufInitS(&battery->technology, "Nickel Zinc");
-            else if(memcmp(bi.Chemistry, "RAM\0", 4) == 0)
-                ffStrbufInitS(&battery->technology, "Rechargeable Alkaline-Manganese");
+            BATTERY_STATUS bs;
+            BATTERY_WAIT_STATUS bws = { .BatteryTag = bqi.BatteryTag };
+            if(DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_STATUS, &bws, sizeof(bws), &bs, sizeof(bs), &dwOut, NULL) && bs.Capacity != BATTERY_UNKNOWN_CAPACITY)
+                battery->capacity = bs.Capacity * 100.0 / bi.FullChargedCapacity;
             else
-                ffStrbufInitS(&battery->technology, "Unknown");
-
-            {
-                ffStrbufInit(&battery->modelName);
-                bqi.InformationLevel = BatteryDeviceName;
-                wchar_t name[64];
-                if(DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_INFORMATION, &bqi, sizeof(bqi), name, sizeof(name), &dwOut, NULL))
-                    ffStrbufSetWS(&battery->modelName, name);
-            }
-
-            {
-                ffStrbufInit(&battery->manufacturer);
-                bqi.InformationLevel = BatteryManufactureName;
-                wchar_t name[64];
-                if(DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_INFORMATION, &bqi, sizeof(bqi), name, sizeof(name), &dwOut, NULL))
-                    ffStrbufSetWS(&battery->manufacturer, name);
-            }
-
-            battery->temperature = 0.0/0.0;
-            if(options->temp)
-            {
-                bqi.InformationLevel = BatteryTemperature;
-                ULONG temp;
-                if(DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_INFORMATION, &bqi, sizeof(bqi), &temp, sizeof(temp), &dwOut, NULL))
-                    battery->temperature = temp;
-            }
-
-            {
-                BATTERY_STATUS bs;
-                BATTERY_WAIT_STATUS bws = { .BatteryTag = bqi.BatteryTag };
-                if(DeviceIoControl(hBattery, IOCTL_BATTERY_QUERY_STATUS, &bws, sizeof(bws), &bs, sizeof(bs), &dwOut, NULL) && bs.Capacity != BATTERY_UNKNOWN_CAPACITY)
-                    battery->capacity = bs.Capacity * 100.0 / bi.FullChargedCapacity;
-                else
-                    battery->capacity = 0;
-
-                ffStrbufInit(&battery->status);
-                if(bs.PowerState & BATTERY_POWER_ON_LINE)
-                    ffStrbufAppendS(&battery->status, "AC Connected, ");
-                if(bs.PowerState & BATTERY_DISCHARGING)
-                    ffStrbufAppendS(&battery->status, "Discharging, ");
-                if(bs.PowerState & BATTERY_CHARGING)
-                    ffStrbufAppendS(&battery->status, "Charging");
-                if(bs.PowerState & BATTERY_CRITICAL)
-                    ffStrbufAppendS(&battery->status, "Critical, ");
-                ffStrbufTrimRight(&battery->status, ' ');
-                ffStrbufTrimRight(&battery->status, ',');
-            }
+                battery->capacity = 0;
+
+            ffStrbufInit(&battery->status);
+            if(bs.PowerState & BATTERY_POWER_ON_LINE)
+                ffStrbufAppendS(&battery->status, "AC Connected, ");
+            if(bs.PowerState & BATTERY_DISCHARGING)
+                ffStrbufAppendS(&battery->status, "Discharging, ");
+            if(bs.PowerState & BATTERY_CHARGING)
+                ffStrbufAppendS(&battery->status, "Charging, ");
+            if(bs.PowerState & BATTERY_CRITICAL)
+                ffStrbufAppendS(&battery->status, "Critical, ");
+            ffStrbufTrimRight(&battery->status, ' ');
+            ffStrbufTrimRight(&battery->status, ',');
         }
     }
-    else
+    return NULL;
+}
+
+static const char* detectWithNtApi(FFBatteryOptions* options, FFlist* results)
+{
+    SYSTEM_BATTERY_STATE info;
+    if (NT_SUCCESS(NtPowerInformation(SystemBatteryState, NULL, 0, &info, sizeof(info))) && info.BatteryPresent)
     {
-        SYSTEM_BATTERY_STATE info;
-        if (NT_SUCCESS(NtPowerInformation(SystemBatteryState, NULL, 0, &info, sizeof(info))) && info.BatteryPresent)
+        FFBatteryResult* battery = (FFBatteryResult*)ffListAdd(results);
+        ffStrbufInit(&battery->modelName);
+        ffStrbufInit(&battery->manufacturer);
+        ffStrbufInit(&battery->technology);
+        ffStrbufInit(&battery->status);
+        battery->temperature = 0.0/0.0;
+        battery->cycleCount = 0;
+
+        battery->capacity = info.RemainingCapacity * 100.0 / info.MaxCapacity;
+        if(info.AcOnLine)
         {
-            FFBatteryResult* battery = (FFBatteryResult*)ffListAdd(results);
-            ffStrbufInit(&battery->modelName);
-            ffStrbufInit(&battery->manufacturer);
-            ffStrbufInit(&battery->technology);
-            ffStrbufInit(&battery->status);
-            battery->temperature = 0.0/0.0;
-
-            battery->capacity = info.RemainingCapacity * 100.0 / info.MaxCapacity;
-            if(info.AcOnLine)
-            {
-                ffStrbufAppendS(&battery->status, "AC Connected");
-                if(info.Charging)
-                    ffStrbufAppendS(&battery->status, ", Charging");
-            }
-            else if(info.Discharging)
-                ffStrbufAppendS(&battery->status, "Discharging");
+            ffStrbufAppendS(&battery->status, "AC Connected");
+            if(info.Charging)
+                ffStrbufAppendS(&battery->status, ", Charging");
         }
+        else if(info.Discharging)
+            ffStrbufAppendS(&battery->status, "Discharging");
+        return NULL;
     }
+    return "NtPowerInformation(SystemBatteryState) failed";
+}
 
-    return NULL;
+const char* ffDetectBattery(FFBatteryOptions* options, FFlist* results)
+{
+    return true
+        ? detectWithSetupApi(options, results)
+        : detectWithNtApi(options, results);
 }
diff --git a/src/modules/battery/battery.c b/src/modules/battery/battery.c
@@ -6,7 +6,7 @@
 #include "modules/battery/battery.h"
 #include "util/stringUtils.h"
 
-#define FF_BATTERY_NUM_FORMAT_ARGS 5
+#define FF_BATTERY_NUM_FORMAT_ARGS 7
 
 static void printBattery(FFBatteryOptions* options, FFBatteryResult* result, uint8_t index)
 {
@@ -70,6 +70,7 @@ static void printBattery(FFBatteryOptions* options, FFBatteryResult* result, uin
             {FF_FORMAT_ARG_TYPE_STRBUF, &capacityStr},
             {FF_FORMAT_ARG_TYPE_STRBUF, &result->status},
             {FF_FORMAT_ARG_TYPE_DOUBLE, &result->temperature},
+            {FF_FORMAT_ARG_TYPE_UINT, &result->cycleCount},
         });
     }
 }
@@ -215,6 +216,7 @@ void ffGenerateBatteryJsonResult(FFBatteryOptions* options, yyjson_mut_doc* doc,
         yyjson_mut_obj_add_strbuf(doc, obj, "status", &battery->status);
         yyjson_mut_obj_add_strbuf(doc, obj, "technology", &battery->technology);
         yyjson_mut_obj_add_real(doc, obj, "temperature", battery->temperature);
+        yyjson_mut_obj_add_uint(doc, obj, "cycleCount", battery->cycleCount);
     }
 
     FF_LIST_FOR_EACH(FFBatteryResult, battery, results)
@@ -233,7 +235,9 @@ void ffPrintBatteryHelpFormat(void)
         "Battery model",
         "Battery technology",
         "Battery capacity (percentage)",
-        "Battery status"
+        "Battery status",
+        "Battery temperature",
+        "Battery cycle count",
     });
 }
 

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ const char* ffDetectBattery(FFBatteryOptions* options, FFlist* results)`
`56`	`56`	`ffStrbufAppendS(&battery->modelName, "Built-in");`
`57`	`57`	`}`
`58`	`58`
`59`		`- ffCfDictGetInt(properties, CFSTR("CycleCount"), &battery->cycleCount);`
	`59`	`+ ffCfDictGetInt(properties, CFSTR("CycleCount"), (int32_t*) &battery->cycleCount);`
`60`	`60`
`61`	`61`	`if (!ffCfDictGetBool(properties, CFSTR("ExternalConnected"), &boolValue) && boolValue)`
`62`	`62`	`ffStrbufAppendS(&battery->status, "AC connected, ");`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`#include "modules/battery/battery.h"`
`7`	`7`	`#include "util/stringUtils.h"`
`8`	`8`
`9`		`-#define FF_BATTERY_NUM_FORMAT_ARGS 5`
	`9`	`+#define FF_BATTERY_NUM_FORMAT_ARGS 7`
`10`	`10`
`11`	`11`	`static void printBattery(FFBatteryOptions* options, FFBatteryResult* result, uint8_t index)`
`12`	`12`	`{`
`@@ -70,6 +70,7 @@ static void printBattery(FFBatteryOptions* options, FFBatteryResult* result, uin`
`70`	`70`	`{FF_FORMAT_ARG_TYPE_STRBUF, &capacityStr},`
`71`	`71`	`{FF_FORMAT_ARG_TYPE_STRBUF, &result->status},`
`72`	`72`	`{FF_FORMAT_ARG_TYPE_DOUBLE, &result->temperature},`
	`73`	`+ {FF_FORMAT_ARG_TYPE_UINT, &result->cycleCount},`
`73`	`74`	`});`
`74`	`75`	`}`
`75`	`76`	`}`
`@@ -215,6 +216,7 @@ void ffGenerateBatteryJsonResult(FFBatteryOptions* options, yyjson_mut_doc* doc,`
`215`	`216`	`yyjson_mut_obj_add_strbuf(doc, obj, "status", &battery->status);`
`216`	`217`	`yyjson_mut_obj_add_strbuf(doc, obj, "technology", &battery->technology);`
`217`	`218`	`yyjson_mut_obj_add_real(doc, obj, "temperature", battery->temperature);`
	`219`	`+ yyjson_mut_obj_add_uint(doc, obj, "cycleCount", battery->cycleCount);`
`218`	`220`	`}`
`219`	`221`
`220`	`222`	`FF_LIST_FOR_EACH(FFBatteryResult, battery, results)`
`@@ -233,7 +235,9 @@ void ffPrintBatteryHelpFormat(void)`
`233`	`235`	`"Battery model",`
`234`	`236`	`"Battery technology",`
`235`	`237`	`"Battery capacity (percentage)",`
`236`		`- "Battery status"`
	`238`	`+ "Battery status",`
	`239`	`+ "Battery temperature",`
	`240`	`+ "Battery cycle count",`
`237`	`241`	`});`
`238`	`242`	`}`
`239`	`243`