Changeset 48517 in vbox for trunk

Timestamp:

Sep 18, 2013 1:43:27 PM (11 years ago)

Author:

vboxsync

Message:

Mac OS host LEDs sync: when in VM - broadcast LEDs state to all attached KBDs, when switching to host - restore aech KBD leds separately.

Location:

trunk/src/VBox/Frontends/VirtualBox/src

Files:

• platform/darwin/DarwinKeyboard.cpp (modified) (6 diffs)
• platform/darwin/DarwinKeyboard.h (modified) (1 diff)
• runtime/UIMachineLogic.cpp (modified) (4 diffs)
• runtime/UIMachineLogic.h (modified) (1 diff)

trunk/src/VBox/Frontends/VirtualBox/src/platform/darwin/DarwinKeyboard.cpp

@@ -288 +288 @@
 #endif /* USE_HID_FOR_MODIFIERS */
 
+/* HID LEDs synchronization data: LED states. */
+typedef struct VBoxHidLeds_t {
+    bool             fNumLockOn;
+    bool             fCapsLockOn;
+    bool             fScrollLockOn;
+} VBoxHidLeds_t;
+
+/* HID LEDs synchronization data: IOKit specific data. */
+typedef struct VBoxHidsState_t {
+    IOHIDManagerRef  hidManagerRef;
+    IOHIDDeviceRef  *hidDevicesCollection;
+    VBoxHidLeds_t   *hidLedsCollection;
+    CFIndex          cDevices;
+} VBoxHidsState_t;
+
 
 /*******************************************************************************
@@ -1204 +1219 @@
 
 /** Turn ON or OFF a particular LED. */
-static void darwinLedElementSetValue(IOHIDDeviceRef hidDevice, IOHIDElementRef element, bool fEnabled)
+static int darwinLedElementSetValue(IOHIDDeviceRef hidDevice, IOHIDElementRef element, bool fEnabled)
 {
     IOHIDValueRef valueRef;
-    IOReturn      rc;
+    IOReturn      rc = kIOReturnError;
 
     valueRef = IOHIDValueCreateWithIntegerValue(kCFAllocatorDefault, element, 0, (fEnabled) ? 1 : 0);
@@ -1220 +1235 @@
         CFRelease(valueRef);
     }
+
+    return rc;
+}
+
+/** Get state of a particular led. */
+static int darwinLedElementGetValue(IOHIDDeviceRef hidDevice, IOHIDElementRef element, bool *fEnabled)
+{
+    IOHIDValueRef valueRef;
+    IOReturn      rc;
+    CFIndex       integerValue;
+
+    rc = IOHIDDeviceGetValue(hidDevice, element, &valueRef);
+    if (rc == kIOReturnSuccess)
+    {
+        integerValue = IOHIDValueGetIntegerValue(valueRef);
+        switch (integerValue)
+        {
+            case 0:
+                *fEnabled = false;
+                break;
+            case 1:
+                *fEnabled = true;
+                break;
+            default:
+                rc = kIOReturnError;
+        }
+    }
+
+    return rc;
 }
 
 /** Set corresponding states from NumLock, CapsLock and ScrollLock leds. */
-static void darwinUpdateHostLedDeviceElements(IOHIDDeviceRef hidDevice, CFDictionaryRef elementMatchingDict,
-                                              bool fNumLockOn, bool fCapsLockOn, bool fScrollLockOn)
+static int darwinSetDeviceLedsState(IOHIDDeviceRef hidDevice, CFDictionaryRef elementMatchingDict,
+                                    bool fNumLockOn, bool fCapsLockOn, bool fScrollLockOn)
 {
     CFArrayRef matchingElementsArrayRef;
+    int        rc2 = 0;
 
     matchingElementsArrayRef = IOHIDDeviceCopyMatchingElements(hidDevice, elementMatchingDict, 0);
@@ -1238 +1283 @@
             IOHIDElementRef element = (IOHIDElementRef)CFArrayGetValueAtIndex(matchingElementsArrayRef, i);
             uint32_t        usage   = IOHIDElementGetUsage(element);
+            int             rc = 0;
 
             switch (usage)
             {
                 case kHIDUsage_LED_NumLock:
-                    darwinLedElementSetValue(hidDevice, element, fNumLockOn);
+                    rc = darwinLedElementSetValue(hidDevice, element, fNumLockOn);
                     break;
 
                 case kHIDUsage_LED_CapsLock:
-                    darwinLedElementSetValue(hidDevice, element, fCapsLockOn);
+                    rc = darwinLedElementSetValue(hidDevice, element, fCapsLockOn);
                     break;
 
                 case kHIDUsage_LED_ScrollLock:
-                    darwinLedElementSetValue(hidDevice, element, fScrollLockOn);
+                    rc = darwinLedElementSetValue(hidDevice, element, fScrollLockOn);
                     break;
             }
-
-        }
-    }
+            if (rc != 0)
+            {
+                Log2(("Failed to set led (%d) state\n", (int)IOHIDElementGetUsage(element)));
+                rc2 = kIOReturnError;
+            }
+
+        }
+    }
+
+    return rc2;
+}
+
+/** Get corresponding states for NumLock, CapsLock and ScrollLock leds. */
+static int darwinGetDeviceLedsState(IOHIDDeviceRef hidDevice, CFDictionaryRef elementMatchingDict,
+                                    bool *fNumLockOn, bool *fCapsLockOn, bool *fScrollLockOn)
+{
+    CFArrayRef matchingElementsArrayRef;
+    int        rc2 = 0;
+
+    matchingElementsArrayRef = IOHIDDeviceCopyMatchingElements(hidDevice, elementMatchingDict, 0);
+    if (matchingElementsArrayRef)
+    {
+        CFIndex cElements = CFArrayGetCount(matchingElementsArrayRef);
+
+        /* Cycle though all the elements we found */
+        for (CFIndex i = 0; i < cElements; i++)
+        {
+            IOHIDElementRef element = (IOHIDElementRef)CFArrayGetValueAtIndex(matchingElementsArrayRef, i);
+            uint32_t        usage   = IOHIDElementGetUsage(element);
+            int             rc = 0;
+
+            switch (usage)
+            {
+                case kHIDUsage_LED_NumLock:
+                    rc = darwinLedElementGetValue(hidDevice, element, fNumLockOn);
+                    break;
+
+                case kHIDUsage_LED_CapsLock:
+                    rc = darwinLedElementGetValue(hidDevice, element, fCapsLockOn);
+                    break;
+
+                case kHIDUsage_LED_ScrollLock:
+                    rc = darwinLedElementGetValue(hidDevice, element, fScrollLockOn);
+                    break;
+            }
+            if (rc != 0)
+            {
+                Log2(("Failed to get led (%d) state\n", (int)IOHIDElementGetUsage(element)));
+                rc2 = kIOReturnError;
+            }
+        }
+    }
+
+    return rc2;
+}
+
+/** Save the states of leds for all HID devices attached to the system and return it. */
+void * DarwinHidDevicesKeepLedsState(void)
+{
+    IOReturn         rc;
+    VBoxHidsState_t *hidsState;
+
+    hidsState = (VBoxHidsState_t *)RTMemAllocZ(sizeof(VBoxHidsState_t));
+    if (hidsState)
+    {
+        hidsState->hidManagerRef = IOHIDManagerCreate(kCFAllocatorDefault, 0);
+        if (hidsState->hidManagerRef)
+        {
+
+            CFDictionaryRef deviceMatchingDictRef = darwinGetLedDeviceMatchingDictionary();
+            if (deviceMatchingDictRef)
+            {
+                IOHIDManagerSetDeviceMatching(hidsState->hidManagerRef, deviceMatchingDictRef);
+
+                rc = IOHIDManagerOpen(hidsState->hidManagerRef, kIOHIDOptionsTypeNone);
+                if (rc == kIOReturnSuccess)
+                {
+                    CFSetRef hidDevicesSetRef;
+
+                    hidDevicesSetRef = IOHIDManagerCopyDevices(hidsState->hidManagerRef);
+                    if (hidDevicesSetRef)
+                    {
+                        /* Get all the available devices and cycle through them. */
+                        hidsState->cDevices = CFSetGetCount(hidDevicesSetRef);
+                        hidsState->hidDevicesCollection = (IOHIDDeviceRef *)RTMemAllocZ((size_t)hidsState->cDevices * sizeof(IOHIDDeviceRef));
+                        if (hidsState->hidDevicesCollection)
+                        {
+                            hidsState->hidLedsCollection = (VBoxHidLeds_t *)RTMemAllocZ((size_t)hidsState->cDevices * sizeof(VBoxHidLeds_t));
+                            if (hidsState->hidLedsCollection)
+                            {
+                                CFSetGetValues(hidDevicesSetRef, (const void **)hidsState->hidDevicesCollection);
+
+                                CFDictionaryRef elementMatchingDict = darwinGetLedElementMatchingDictionary();
+                                if (elementMatchingDict)
+                                {
+                                    for (CFIndex i = 0; i < hidsState->cDevices; i++)
+                                    {
+                                        if (IOHIDDeviceConformsTo(hidsState->hidDevicesCollection[i], kHIDPage_GenericDesktop, kHIDUsage_GD_Keyboard))
+                                        {
+                                            rc = darwinGetDeviceLedsState(hidsState->hidDevicesCollection[i],
+                                                                          elementMatchingDict,
+                                                                          &hidsState->hidLedsCollection[i].fNumLockOn,
+                                                                          &hidsState->hidLedsCollection[i].fCapsLockOn,
+                                                                          &hidsState->hidLedsCollection[i].fScrollLockOn);
+                                            /* This should never happen, but if happened -- mark all the leds of current
+                                             * device as turned OFF. */
+                                            if (rc != 0)
+                                            {
+                                                Log2(("Unable to get leds state for device %d. Mark leds as turned off\n", (int)i));
+                                                hidsState->hidLedsCollection[i].fNumLockOn    =
+                                                hidsState->hidLedsCollection[i].fCapsLockOn   =
+                                                hidsState->hidLedsCollection[i].fScrollLockOn = false;
+                                            }
+
+                                        }
+                                    }
+
+                                    CFRelease(deviceMatchingDictRef);
+                                    CFRelease(elementMatchingDict);
+
+                                    return hidsState;
+                                }
+
+                                RTMemFree(hidsState->hidLedsCollection);
+                            }
+
+                            RTMemFree(hidsState->hidDevicesCollection);
+                        }
+                    }
+
+                    rc = IOHIDManagerClose(hidsState->hidManagerRef, 0);
+                    if (rc != kIOReturnSuccess)
+                        LogRelFlow(("Warning! Something went wrong in attempt to close HID device manager!\n"));
+                }
+
+                CFRelease(deviceMatchingDictRef);
+            }
+
+            CFRelease(hidsState->hidManagerRef);
+        }
+
+        RTMemFree(hidsState);
+    }
+
+    return NULL;
+}
+
+/**
+ * Apply LEDs state stored in *pState and release resources aquired by *pState.
+ *
+ * @param pState            Pointer to saved LEDs state
+ *
+ * @return 0 on success, error code otherwise.
+ */
+int DarwinHidDevicesApplyAndReleaseLedsState(void *pState)
+{
+    VBoxHidsState_t *hidsState = (VBoxHidsState_t *)pState;
+
+    CFIndex     i;
+    IOReturn    rc, rc2 = 0;
+
+    if (hidsState)
+    {
+        CFDictionaryRef elementMatchingDict = darwinGetLedElementMatchingDictionary();
+        if (elementMatchingDict)
+        {
+            /* Restore LEDs */
+            for (i = 0; i < hidsState->cDevices; i++)
+            {
+                rc = darwinSetDeviceLedsState(hidsState->hidDevicesCollection[i],
+                                              elementMatchingDict,
+                                              hidsState->hidLedsCollection[i].fNumLockOn,
+                                              hidsState->hidLedsCollection[i].fCapsLockOn,
+                                              hidsState->hidLedsCollection[i].fScrollLockOn);
+                if (rc != 0)
+                {
+                    Log2(("Unable to restore led states for device (%d)!\n", (int)i));
+                    rc2 = kIOReturnError;
+                }
+            }
+        }
+
+        /* Free resources */
+
+        RTMemFree(hidsState->hidLedsCollection);
+        RTMemFree(hidsState->hidDevicesCollection);
+
+        rc = IOHIDManagerClose(hidsState->hidManagerRef, 0);
+        if (rc != kIOReturnSuccess)
+            LogRelFlow(("Warning! Something went wrong in attempt to close HID device manager!\n"));
+
+        CFRelease(hidsState->hidManagerRef);
+
+        RTMemFree(hidsState);
+    }
+
+    return rc2;
 }
 
@@ -1268 +1508 @@
  * @param fScrollLockOn     Turn on ScrollLock led if TRUE, turn off otherwise
  */
-void DarwinUpdateHostLedDevices(bool fNumLockOn, bool fCapsLockOn, bool fScrollLockOn)
+void DarwinHidDevicesBroadcastLeds(bool fNumLockOn, bool fCapsLockOn, bool fScrollLockOn)
 {
     IOReturn        rc;
@@ -1301 +1541 @@
                             for (CFIndex i = 0; i < cDevices; i++)
                             {
-                                if (hidDevicesCollection[i])
+                                if (IOHIDDeviceConformsTo(hidDevicesCollection[i], kHIDPage_GenericDesktop, kHIDUsage_GD_Keyboard))
                                 {
-                                    if (IOHIDDeviceConformsTo(hidDevicesCollection[i], kHIDPage_GenericDesktop, kHIDUsage_GD_Keyboard))
-                                    {
-                                        darwinUpdateHostLedDeviceElements(hidDevicesCollection[i], elementMatchingDict,
-                                                                          fNumLockOn, fCapsLockOn, fScrollLockOn);
-                                    }
+                                    rc = darwinSetDeviceLedsState(hidDevicesCollection[i], elementMatchingDict,
+                                                                  fNumLockOn, fCapsLockOn, fScrollLockOn);
+                                    if (rc != 0)
+                                        Log2(("Unable to broadcast LEDs state to device (%d)\n", (int)i));
                                 }
                             }

trunk/src/VBox/Frontends/VirtualBox/src/platform/darwin/DarwinKeyboard.h

@@ -47 +47 @@
 void     DarwinReleaseKeyboard(void);
 
-void     DarwinUpdateHostLedDevices(bool fNumLockOn, bool fCapsLockOn, bool fScrollLockOn);
+void   * DarwinHidDevicesKeepLedsState(void);
+int      DarwinHidDevicesApplyAndReleaseLedsState(void *pState);
+void     DarwinHidDevicesBroadcastLeds(bool fNumLockOn, bool fCapsLockOn, bool fScrollLockOn);
 
 RT_C_DECLS_END

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.cpp

@@ -490 +490 @@
     LogRelFlow(("UIMachineLogic::sltKeyboardLedsChanged: Updating host LED lock states (NOT IMPLEMENTED).\n"));
 #ifdef Q_WS_MAC
-    //DarwinUpdateHostLedDevices(uisession()->isNumLock(), uisession()->isCapsLock(), uisession()->isScrollLock());
+    DarwinHidDevicesBroadcastLeds(uisession()->isNumLock(), uisession()->isCapsLock(), uisession()->isScrollLock());
 #endif
 }
@@ -567 +567 @@
     , m_pDockPreviewSelectMonitorGroup(0)
     , m_DockIconPreviewMonitor(0)
+    , m_hostLedsState(NULL)
 #endif /* Q_WS_MAC */
 {
@@ -2190 +2191 @@
     /* Here we have to update host LED lock states using values provided by UISession registry.
      * [bool] uisession() -> isNumLock(), isCapsLock(), isScrollLock() can be used for that. */
+#ifdef Q_WS_MAC
+    if (m_hostLedsState == NULL)
+        m_hostLedsState = DarwinHidDevicesKeepLedsState();
+    DarwinHidDevicesBroadcastLeds(uisession()->isNumLock(), uisession()->isCapsLock(), uisession()->isScrollLock());
+#endif /* Q_WS_MAC */
 }
 
@@ -2201 +2207 @@
 
     /* Here we have to restore host LED lock states. */
+#ifdef Q_WS_MAC
+    if (m_hostLedsState)
+    {
+        DarwinHidDevicesApplyAndReleaseLedsState(m_hostLedsState);
+        m_hostLedsState = NULL;
+    }
+#endif /* Q_WS_MAC */
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.h

@@ -268 +268 @@
     QActionGroup *m_pDockPreviewSelectMonitorGroup;
     int m_DockIconPreviewMonitor;
+    void *m_hostLedsState;
 #endif /* Q_WS_MAC */