Dynamically connect to EC

If the EC driver is not installed or runinng when the sensor driver
starts, need to fail gracefully instead of preventing driver start and
yellow bang.

So instead we keep checking and connect to the EC at the first chance.

Signed-off-by: Daniel Schaefer <dhs@frame.work>

Author: JohnAZoidberg

FrameworkSensors/AccelerometerClient.cpp

@@ -38,14 +38,18 @@ typedef enum
     ACCELEROMETER_DATA_COUNT
 } ACCELEROMETER_DATA_INDEX;
 
-UINT8 CrosEcGetMotionSensorCount(HANDLE Handle)
+NTSTATUS CrosEcGetMotionSensorCount(HANDLE Handle, UINT8 *Count)
 {
     EC_REQUEST_MOTION_SENSE_DUMP req{};
     EC_RESPONSE_MOTION_SENSE_DUMP res{};
 
     if (Handle == INVALID_HANDLE_VALUE) {
         TraceError("%!FUNC! Handle is invalid");
-        return 0;
+        return STATUS_INVALID_PARAMETER;
+    }
+    if (Count == nullptr) {
+        TraceError("%!FUNC! Count==NULL");
+        return STATUS_INVALID_PARAMETER;
     }
 
     req.Cmd = 0;
@@ -60,21 +64,21 @@ UINT8 CrosEcGetMotionSensorCount(HANDLE Handle)
         sizeof(res)
     )) {
         TraceError("%!FUNC! EC_CMD_MOTION_SENSE_DUMP failed");
-        return 0;
+        return STATUS_NOT_FOUND;
     }
 
-    return res.SensorCount;
+    *Count = res.SensorCount;
+    return STATUS_SUCCESS;
 }
 
 // Returns STATUS_NOT_FOUND if either base or lid accelerometer sensors are not found.
 NTSTATUS
-CrosEcGetAccelIndeces(HANDLE Handle, UINT8 *BaseSensor, UINT8 *LidSensor)
+CrosEcGetAccelIndeces(HANDLE Handle, UINT8 *BaseSensor, UINT8 *LidSensor, UINT8 SensorCount)
 {
     EC_REQUEST_MOTION_SENSE_INFO req{};
     EC_RESPONSE_MOTION_SENSE_INFO res{};
     BOOLEAN FoundBase = FALSE;
     BOOLEAN FoundLid = FALSE;
-    UINT8 SensorCount = 0;
 
     if (Handle == INVALID_HANDLE_VALUE) {
         TraceError("%!FUNC! Handle is invalid");
@@ -87,8 +91,6 @@ CrosEcGetAccelIndeces(HANDLE Handle, UINT8 *BaseSensor, UINT8 *LidSensor)
         return STATUS_INVALID_PARAMETER;
     }
 
-    SensorCount = CrosEcGetMotionSensorCount(Handle);
-
     for (UINT8 i = 0; i < SensorCount; i++)
     {
         req.Cmd = 1;
@@ -164,24 +166,36 @@ AccelerometerDevice::Initialize(
     m_Device = Device;
     m_SensorInstance = SensorInstance;
     m_Started = FALSE;
+    SensorCount = 0;
     // Sensible defaults - applies to most devices
     m_LidSensorIndex = 0;
     m_LidBaseSensor = 1;
+    Context->m_CrosEcHandle = INVALID_HANDLE_VALUE;
 
-    SensorCount = CrosEcGetMotionSensorCount(Context->m_CrosEcHandle);
+    // Make sure we have a handle to the EC driver
+    ConnectToEc(&Context->m_CrosEcHandle);
+
+    Status = CrosEcGetMotionSensorCount(Context->m_CrosEcHandle, &SensorCount);
     TraceInformation("%!FUNC! Found %d Sensors on this device", SensorCount);
-    if (SensorCount == 0)
+    // If the EC is present, we evaluate the responses,
+    // If not just ignore it and try again later.
+    // Want to avoid failing the driver load if the EC is not present.
+    if (NT_SUCCESS(Status))
     {
-        TraceError("%!FUNC! No Sensors available. Not initializing AccelerometerClient");
-        Status = STATUS_NOT_FOUND;
-        goto Exit;
-    }
+        if (SensorCount == 0)
+        {
+            TraceError("%!FUNC! No Sensors available. Not initializing AccelerometerClient");
+            Status = STATUS_NOT_FOUND;
+            goto Exit;
+        }
 
-    Status = CrosEcGetAccelIndeces(Context->m_CrosEcHandle, &m_LidSensorIndex, &m_LidBaseSensor);
-    if (!NT_SUCCESS(Status))
-    {
-        TraceError("%!FUNC! Failed to get accelerometer indeces: %!STATUS!", Status);
-        goto Exit;
+        Status = CrosEcGetAccelIndeces(Context->m_CrosEcHandle, &m_LidSensorIndex, &m_LidBaseSensor, SensorCount);
+        if (!NT_SUCCESS(Status))
+        {
+            TraceError("%!FUNC! Failed to get accelerometer indeces: %!STATUS!", Status);
+            Status = STATUS_NOT_FOUND;
+            goto Exit;
+        }
     }
 
     //
@@ -515,6 +529,13 @@ AccelerometerDevice::GetData(
 
     SENSOR_FunctionEnter();
 
+    if (Handle == INVALID_HANDLE_VALUE) {
+        TraceError("%!FUNC! Handle is invalid");
+        return STATUS_INVALID_HANDLE;
+    }
+
+    // TODO: Might want to check if sensor indeces are initialized
+
     UINT8 acc_status = 0;
     CrosEcReadMemU8(Handle, EC_MEMMAP_ACC_STATUS, &acc_status);
     TraceInformation("Status: (%02x), Present: %d, Busy: %d\n",
@@ -663,4 +684,4 @@ AccelerometerDevice::UpdateCachedThreshold(
 Exit:
     SENSOR_FunctionExit(Status);
     return Status;
-}
+}

FrameworkSensors/Clients.cpp

@@ -10,6 +10,7 @@
 //  Windows User-Mode Driver Framework (WUDF)
 
 #include "Clients.h"
+#include "EcCommunication.h"
 
 #include "Clients.tmh"
 
@@ -47,6 +48,8 @@ OnTimerExpire(
 
     // Get data and push to clx
     Lock(pDevice->m_Lock);
+    // Make sure we have a handle to the EC driver
+    ConnectToEc(&pDevice->m_CrosEcHandle);
     Status = pDevice->GetData(pDevice->m_CrosEcHandle);
     if (!NT_SUCCESS(Status) && Status != STATUS_DATA_NOT_ACCEPTED)
     {

FrameworkSensors/Device.cpp

@@ -219,43 +219,9 @@ OnPrepareHardware(
     )
 {
     NTSTATUS Status = STATUS_SUCCESS;
-    ULONG  i;
-    HANDLE Handle;
-    DWORD retb{};
-    CROSEC_READMEM rm{};
 
     SENSOR_FunctionEnter();
 
-    Status = ConnectToEc(&Handle);
-    if (!NT_SUCCESS(Status)) {
-        TraceError("COMBO %!FUNC! ConnectToEc failed %!STATUS!", Status);
-        goto Exit;
-    }
-
-    rm.bytes = 0xfe;
-    rm.offset = 0;
-    Status = DeviceIoControl(Handle,
-        (DWORD) IOCTL_CROSEC_RDMEM,
-        &rm,
-        sizeof(rm),
-        &rm,
-        sizeof(rm),
-        &retb,
-        nullptr);
-    if (!NT_SUCCESS(Status)) {
-        TraceError("COMBO %!FUNC! ConnectToEc failed %!STATUS!", Status);
-        goto Exit;
-    }
-
-    UINT8 *EcMem = rm.buffer;
-    for (i = 0; i < 0xfe-16; i+=16) {
-        TraceInformation(
-            "%02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\n",
-            EcMem[i], EcMem[i+1], EcMem[i+2], EcMem[i+3], EcMem[i+4], EcMem[i + 5], EcMem[i + 6], EcMem[i + 7],
-            EcMem[i + 8], EcMem[i+9], EcMem[i+10], EcMem[i+11], EcMem[i+12], EcMem[i + 13], EcMem[i + 14], EcMem[i + 15]
-        );
-    }
-
     for (ULONG Count = 0; Count < SensorInstanceCount; Count++)
     {
         PComboDevice pDevice = nullptr;
@@ -285,7 +251,7 @@ OnPrepareHardware(
 
         AllocateDeviceAtIndex(Count, &pDevice);
 
-        pDevice->m_CrosEcHandle = Handle;
+        pDevice->m_CrosEcHandle = INVALID_HANDLE_VALUE;
 
         // Fill out properties
         Status = pDevice->Initialize(Device, SensorInstance);

FrameworkSensors/EcCommunication.cpp

@@ -23,6 +23,12 @@ NTSTATUS ConnectToEc(
 ) {
     NTSTATUS Status = STATUS_SUCCESS;
 
+    if (*Handle != INVALID_HANDLE_VALUE) {
+        // Already connected
+        TraceError("%!FUNC! Already connected");
+        return Status;
+    }
+
     *Handle = CreateFileW(
         LR"(\\.\GLOBALROOT\Device\CrosEC)",
         GENERIC_READ | GENERIC_WRITE,
@@ -37,6 +43,7 @@ NTSTATUS ConnectToEc(
         return STATUS_INVALID_HANDLE;
     }
 
+    TraceInformation("%!FUNC! Got Handle");
     return Status;
 }