Allow toggling of features and fixes via Info.plist values

Signed-off-by: black.dragon74 <[email protected]>

Author: black-dragon74

README.md

@@ -52,6 +52,17 @@ reenumerate -v 0x0b05,0x1869
 
 </details>
 
+## Configuring
+
+You can enable or disable additonal features and fixes in this driver by editing the Info.plist file of the dext. Currently configurable options are:
+
+Setting value to `0` disables and `1` enables the feature/fix.
+
+- `FixCapsLockLED` - Fixes erratic behavior of Caps Lock LED on some keyboards. If your LED didn't work under macOS without this driver. You should disable this feature.
+- `BacklightAutoTurnOff` - Automatically turns off the keyboard backlight after 5 mins of inactivity. Recommended to disable it on devices where there are multiple `IOHIDInterface` nubs for a single device, like `0b05:1866`.
+
+You need to edit ONLY the entry for your vendor and device id. Like for `0b05:1869` I would edit `0b05_1869` entry under `IOKitPersonalities` dict.
+
 ## Building
 
 ### From GitHub:

ROG-HID-Driver/Info.plist

@@ -22,8 +22,12 @@
 	<dict>
 		<key>0b05_1822</key>
 		<dict>
+			<key>BacklightAutoTurnOff</key>
+			<integer>1</integer>
 			<key>CFBundleIdentifier</key>
 			<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+			<key>FixCapsLockLED</key>
+			<integer>1</integer>
 			<key>IOClass</key>
 			<string>AppleUserHIDEventService</string>
 			<key>IOKitDebug</key>
@@ -41,8 +45,12 @@
 		</dict>
 		<key>0b05_1837</key>
 		<dict>
+			<key>BacklightAutoTurnOff</key>
+			<integer>1</integer>
 			<key>CFBundleIdentifier</key>
 			<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+			<key>FixCapsLockLED</key>
+			<integer>1</integer>
 			<key>IOClass</key>
 			<string>AppleUserHIDEventService</string>
 			<key>IOKitDebug</key>
@@ -60,8 +68,12 @@
 		</dict>
 		<key>0b05_1854</key>
 		<dict>
+			<key>BacklightAutoTurnOff</key>
+			<integer>1</integer>
 			<key>CFBundleIdentifier</key>
 			<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+			<key>FixCapsLockLED</key>
+			<integer>1</integer>
 			<key>IOClass</key>
 			<string>AppleUserHIDEventService</string>
 			<key>IOKitDebug</key>
@@ -79,8 +91,12 @@
 		</dict>
 		<key>0b05_1866</key>
 		<dict>
+			<key>BacklightAutoTurnOff</key>
+			<integer>0</integer>
 			<key>CFBundleIdentifier</key>
 			<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+			<key>FixCapsLockLED</key>
+			<integer>0</integer>
 			<key>IOClass</key>
 			<string>AppleUserHIDEventService</string>
 			<key>IOKitDebug</key>
@@ -98,8 +114,12 @@
 		</dict>
 		<key>0b05_1869</key>
 		<dict>
+			<key>BacklightAutoTurnOff</key>
+			<integer>1</integer>
 			<key>CFBundleIdentifier</key>
 			<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+			<key>FixCapsLockLED</key>
+			<integer>1</integer>
 			<key>IOClass</key>
 			<string>AppleUserHIDEventService</string>
 			<key>IOKitDebug</key>

ROG-HID-Driver/ROG_HID_Driver.cpp

@@ -23,6 +23,9 @@ struct ROG_HID_Driver_IVars
     OSArray* customKeyboardElements         { nullptr };
     IODispatchQueue* luxQueue               { nullptr };
     uint8_t kbdFunction                     { 0 };
+    bool fixCapsLockLED                     { false };
+    bool bkltAutoTurnOff                    { false };
+    
     static uint64_t lastEventDispatchTime;
     static uint8_t kbdLux;
     static bool luxIsFadedOut;
@@ -53,6 +56,8 @@ bool ROG_HID_Driver::init()
     if (ivars == nullptr)
         return false;
 
+    ivars->fixCapsLockLED = false;
+    ivars->bkltAutoTurnOff = false;
     _last_dispatch_time = 0;
 
     return true;
@@ -91,6 +96,9 @@ kern_return_t IMPL(ROG_HID_Driver, Start)
     // Read the keyboard functions
     asusKbdGetFunctions();
 
+    // Parse Info.plist
+    parseInfoPlist();
+    
     // Reflect the intital value on lux
     DBGLOG("Trying to set initial kbd lux to: 0x%x", _current_lux);
     asusKbdBacklightSet(_current_lux);
@@ -255,7 +263,7 @@ kern_return_t ROG_HID_Driver::dispatchKeyboardEvent(uint64_t timeStamp, uint32_t
     }
 
     // Fix erratic caps lock key
-    if (usage == kHIDUsage_KeyboardCapsLock)
+    if (usage == kHIDUsage_KeyboardCapsLock && ivars->fixCapsLockLED)
         IOSleep(80);
 
     // Update the last dispatch time to the current mach_time
@@ -339,7 +347,13 @@ void IMPL(ROG_HID_Driver, loadKbdLuxMonitor)
 void IMPL(ROG_HID_Driver, initLuxQueue)
 {
     if (!(SUPPORT_KEYBOARD_BACKLIGHT & _kbd_function)) {
-        DBGLOG("Keyboard baclikght is not supported on this device, abort lux queue init");
+        DBGLOG("Keyboard backlight is not supported on this device, abort lux queue init");
+        return;
+    }
+    
+    if (!ivars->bkltAutoTurnOff)
+    {
+        DBGLOG("Backlight auto turn off is disabled via Info.plist");
         return;
     }
 
@@ -393,6 +407,28 @@ void IMPL(ROG_HID_Driver, initLuxQueue)
     OSSafeReleaseNULL(deviceProps);
 }
 
+void IMPL(ROG_HID_Driver, parseInfoPlist)
+{
+    DBGLOG("Parse custom Info.plist properties");
+    OSContainer* propContainer;
+    
+    SearchProperty("BacklightAutoTurnOff", "IOService", kIOServiceSearchPropertyParents, &propContainer);
+    ivars->fixCapsLockLED = OSDynamicCast(OSNumber, propContainer)->unsigned8BitValue() == kBooleanTrue;
+    DBGLOG("Fix caps lock led: %s", ivars->fixCapsLockLED ? "True" : "False");
+
+    propContainer = nullptr;
+    SearchProperty("BacklightAutoTurnOff", "IOService", kIOServiceSearchPropertyParents, &propContainer);
+    if (!propContainer)
+        goto exit;
+
+    ivars->bkltAutoTurnOff = OSDynamicCast(OSNumber, propContainer)->unsigned8BitValue() == kBooleanTrue;
+    DBGLOG("Backlight auto turn off: %s", ivars->bkltAutoTurnOff ? "True" : "False");
+
+exit:
+    OSSafeReleaseNULL(propContainer);
+    DBGLOG("Done parsing custom Info.plist properties");
+}
+
 kern_return_t IMPL(ROG_HID_Driver, Stop)
 {
     DBGLOG("Stop");
@@ -440,7 +476,7 @@ void IMPL(ROG_HID_Driver, asusKbdInit)
 void IMPL(ROG_HID_Driver, asusKbdBacklightSet)
 {
     if (!(SUPPORT_KEYBOARD_BACKLIGHT & _kbd_function)) {
-        DBGLOG("Setting keyboard baclikght is not supported on this device");
+        DBGLOG("Setting keyboard backlight is not supported on this device");
         return;
     }
 

ROG-HID-Driver/ROG_HID_Driver.iig

@@ -15,6 +15,7 @@
 #define KBD_FEATURE_REPORT_SIZE 16
 #define LUX_FADE_OUT_DELAY STOMS(5 * 60)    /* 5 mins */
 #define SUPPORT_KEYBOARD_BACKLIGHT BIT(0)
+#define kBooleanTrue 0x01
 
 #define LOG_PREFIX "ROG-HID - "
 #define OSLOG(...)                                          \
@@ -65,6 +66,7 @@ public:
 
 private:
     virtual void parseKeyboardElementsHook(OSArray* elements);
+    virtual void parseInfoPlist();
     virtual void setKbdLux(kLuxEvent luxEvent);
     virtual void initLuxQueue();
     virtual void loadKbdLuxMonitor();

ROG-HID.xcodeproj/project.pbxproj

@@ -435,7 +435,7 @@
 					"@executable_path/../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 10.15;
-				MARKETING_VERSION = 1.2;
+				MARKETING_VERSION = 1.3;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.black-dragon74.ROG-HID";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_VERSION = 5.0;
@@ -460,7 +460,7 @@
 					"@executable_path/../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 10.15;
-				MARKETING_VERSION = 1.2;
+				MARKETING_VERSION = 1.3;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.black-dragon74.ROG-HID";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_VERSION = 5.0;
@@ -482,7 +482,7 @@
 					"$(SDKROOT)/System/DriverKit/System/Library/Frameworks",
 				);
 				INFOPLIST_FILE = "ROG-HID-Driver/Info.plist";
-				MARKETING_VERSION = 1.2;
+				MARKETING_VERSION = 1.3;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.black-dragon74.ROG-HID-Driver";
 				PRODUCT_NAME = "$(inherited)";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -506,7 +506,7 @@
 					"$(SDKROOT)/System/DriverKit/System/Library/Frameworks",
 				);
 				INFOPLIST_FILE = "ROG-HID-Driver/Info.plist";
-				MARKETING_VERSION = 1.2;
+				MARKETING_VERSION = 1.3;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.black-dragon74.ROG-HID-Driver";
 				PRODUCT_NAME = "$(inherited)";
 				PROVISIONING_PROFILE_SPECIFIER = "";