First-tier support for DualSense controllers with rumble and LED support

Cocoa/GBView.m

@@ -267,6 +267,12 @@ static const uint8_t workboy_vk_to_key[] = {
         if (analogClockMultiplier == 1.0) {
             analogClockMultiplierValid = false;
         }
+        if (analogClockMultiplier < 2.0 && analogClockMultiplier > 1.0) {
+            GB_set_turbo_mode(_gb, false, false);
+            if (self.document.partner) {
+                GB_set_turbo_mode(self.document.partner.gb, false, false);
+            }
+        }
     }
     else {
         if (underclockKeyDown && clockMultiplier > 0.5) {
@@ -284,10 +290,10 @@ static const uint8_t workboy_vk_to_key[] = {
             }
         }
     }
-    if (clockMultiplier > 1 || _turbo) {
+    if (clockMultiplier > 1 || _turbo || (analogClockMultiplierValid && analogClockMultiplier > 1)) {
         [self.osdView displayText:@"Fast forwarding..."];
     }
-    else if (clockMultiplier < 1) {
+    else if (clockMultiplier < 1 || (analogClockMultiplierValid && analogClockMultiplier < 1)) {
         [self.osdView displayText:@"Slow motion..."];
     }
     current_buffer = (current_buffer + 1) % self.numberOfBuffers;
@@ -461,13 +467,13 @@ static const uint8_t workboy_vk_to_key[] = {
     
     if ((axis.usage == JOYAxisUsageR1 && !mapping) ||
         axis.uniqueID == [mapping[@"AnalogUnderclock"] unsignedLongValue]){
-        analogClockMultiplier = MIN(MAX(1 - axis.value + 0.2, 1.0 / 3), 1.0);
+        analogClockMultiplier = MIN(MAX(1 - axis.value + 0.05, 1.0 / 3), 1.0);
         analogClockMultiplierValid = true;
     }
     
     else if ((axis.usage == JOYAxisUsageL1 && !mapping) ||
         axis.uniqueID == [mapping[@"AnalogTurbo"] unsignedLongValue]){
-        analogClockMultiplier = MIN(MAX(axis.value * 3 + 0.8, 1.0), 3.0);
+        analogClockMultiplier = MIN(MAX(axis.value * 3 + 0.95, 1.0), 3.0);
         analogClockMultiplierValid = true;
     }
 }
@@ -544,17 +550,21 @@ static const uint8_t workboy_vk_to_key[] = {
                     else {
                         GB_set_turbo_mode(_gb, false, false);
                     }
+                    _turbo = false;
                 }
                 break;
             }
         
             case JOYButtonUsageL1: {
+                if (!analogClockMultiplierValid || analogClockMultiplier == 1.0 || !button.isPressed) {
                     if (self.document.isSlave) {
                         GB_set_turbo_mode(self.document.partner.gb, button.isPressed, false); break;
                     }
                     else {
                         GB_set_turbo_mode(_gb, button.isPressed, button.isPressed && self.isRewinding); break;
                     }
+                    _turbo = button.isPressed;
+                }
             }
 
             case JOYButtonUsageR1: underclockKeyDown = button.isPressed; break;

JoyKit/ControllerConfiguration.inc

@@ -79,6 +79,41 @@ hacksByManufacturer = @{
              AXES2D(1): @(JOYAxes2DUsageLeftStick),
              AXES2D(4): @(JOYAxes2DUsageRightStick),
          },
+         
+         // When DualSense mode is activated on BT, The report ID is 0x31 and there's an extra byte
+         JOYCustomReports: @{
+            @(0x31): @[
+            /* 1D and 2D axes */
+            @{@"reportID": @(0x31), @"size":@8, @"offset":@0x08, @"usagePage":@(kHIDPage_GenericDesktop), @"usage":@(kHIDUsage_GD_X), @"min": @0, @"max": @255},
+            @{@"reportID": @(0x31), @"size":@8, @"offset":@0x10, @"usagePage":@(kHIDPage_GenericDesktop), @"usage":@(kHIDUsage_GD_Y), @"min": @0, @"max": @255},
+            @{@"reportID": @(0x31), @"size":@8, @"offset":@0x18, @"usagePage":@(kHIDPage_GenericDesktop), @"usage":@(kHIDUsage_GD_Z), @"min": @0, @"max": @255},
+            @{@"reportID": @(0x31), @"size":@8, @"offset":@0x20, @"usagePage":@(kHIDPage_GenericDesktop), @"usage":@(kHIDUsage_GD_Rz), @"min": @0, @"max": @255},
+            @{@"reportID": @(0x31), @"size":@8, @"offset":@0x28, @"usagePage":@(kHIDPage_GenericDesktop), @"usage":@(kHIDUsage_GD_Rx), @"min": @0, @"max": @255},
+            @{@"reportID": @(0x31), @"size":@8, @"offset":@0x30, @"usagePage":@(kHIDPage_GenericDesktop), @"usage":@(kHIDUsage_GD_Ry), @"min": @0, @"max": @255},
+            
+            /* Hat Switch*/
+            @{@"reportID": @(0x31), @"size":@4, @"offset":@0x40, @"usagePage":@(kHIDPage_GenericDesktop), @"usage":@(kHIDUsage_GD_Hatswitch), @"min": @0, @"max": @7},
+            
+            /* Buttons */
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x44, @"usagePage":@(kHIDPage_Button), @"usage":@1},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x45, @"usagePage":@(kHIDPage_Button), @"usage":@2},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x46, @"usagePage":@(kHIDPage_Button), @"usage":@3},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x47, @"usagePage":@(kHIDPage_Button), @"usage":@4},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x48, @"usagePage":@(kHIDPage_Button), @"usage":@5},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x49, @"usagePage":@(kHIDPage_Button), @"usage":@6},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x4a, @"usagePage":@(kHIDPage_Button), @"usage":@7},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x4b, @"usagePage":@(kHIDPage_Button), @"usage":@8},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x4c, @"usagePage":@(kHIDPage_Button), @"usage":@9},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x4d, @"usagePage":@(kHIDPage_Button), @"usage":@10},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x4e, @"usagePage":@(kHIDPage_Button), @"usage":@11},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x4f, @"usagePage":@(kHIDPage_Button), @"usage":@12},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x50, @"usagePage":@(kHIDPage_Button), @"usage":@13},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x51, @"usagePage":@(kHIDPage_Button), @"usage":@14},
+            @{@"reportID": @(0x31), @"size":@1, @"offset":@0x52, @"usagePage":@(kHIDPage_Button), @"usage":@15},
+            ],
+        },
+         
+         JOYIsSony: @YES,
     }
 };
 

JoyKit/JOYController.m

@@ -26,6 +26,7 @@ static NSString const *JOYSwapZRz = @"JOYSwapZRz";
 static NSString const *JOYActivationReport = @"JOYActivationReport";
 static NSString const *JOYIgnoredReports = @"JOYIgnoredReports";
 static NSString const *JOYIsDualShock3 = @"JOYIsDualShock3";
+static NSString const *JOYIsSony = @"JOYIsSony";
 
 static NSMutableDictionary<id, JOYController *> *controllers; // Physical controllers
 static NSMutableArray<JOYController *> *exposedControllers; // Logical controllers
@@ -125,9 +126,37 @@ typedef struct __attribute__((packed)) {
     uint8_t padding3[13];
 } JOYDualShock3Output;
 
+typedef struct __attribute__((packed)) {
+    uint8_t reportID;
+    uint8_t sequence;
+    union {
+        uint8_t tag;
+        uint8_t reportIDOnUSB;
+    };
+    uint16_t flags;
+    uint8_t rumbleRightStrength; // Weak
+    uint8_t rumbleLeftStrength; // Strong
+    uint8_t reserved[4];
+    uint8_t muteButtonLED;
+    uint8_t powerSaveControl;
+    uint8_t reserved2[28];
+    uint8_t flags2;
+    uint8_t reserved3[2];
+    uint8_t lightbarSetup;
+    uint8_t LEDBrightness;
+    uint8_t playerLEDs;
+    uint8_t lightbarRed;
+    uint8_t lightbarGreen;
+    uint8_t lightbarBlue;
+    uint8_t bluetoothSpecific[24];
+    uint32_t crc32;
+} JOYDualSenseOutput;
+
+
 typedef union {
     JOYSwitchPacket switchPacket;
     JOYDualShock3Output ds3Output;
+    JOYDualSenseOutput dualsenseOutput;
 } JOYVendorSpecificOutput;
 
 @implementation JOYController
@@ -151,6 +180,10 @@ typedef union {
     NSString *_serialSuffix;
     bool _isSwitch; // Does this controller use the Switch protocol?
     bool _isDualShock3; // Does this controller use DS3 outputs?
+    bool _isSony; // Is this a DS4 or newer Sony controller?
+    bool _isDualSense;
+    bool _isUSBDualSense;
+
     JOYVendorSpecificOutput _lastVendorSpecificOutput;
     volatile double _rumbleAmplitude;
     bool _physicallyConnected;
@@ -365,6 +398,7 @@ typedef union {
     _hacks = hacks;
     _isSwitch = [_hacks[JOYIsSwitch] boolValue];
     _isDualShock3 = [_hacks[JOYIsDualShock3] boolValue];
+    _isSony = [_hacks[JOYIsSony] boolValue];
 
     NSDictionary *customReports = hacks[JOYCustomReports];
     _lastReport = [NSMutableData dataWithLength:MAX(
@@ -492,6 +526,32 @@ typedef union {
             }
         };
     }
+    if (_isSony) {
+        _isDualSense = [(__bridge NSNumber *)IOHIDDeviceGetProperty(device, CFSTR(kIOHIDProductIDKey)) unsignedIntValue] == 0xce6;
+    }
+    
+    if (_isDualSense) {
+        _isUSBDualSense = [(__bridge NSString *)IOHIDDeviceGetProperty(_device, CFSTR(kIOHIDTransportKey)) isEqualToString:@"USB"];
+        _lastVendorSpecificOutput.dualsenseOutput = (JOYDualSenseOutput){
+            .reportID = 0x31,
+            .tag = 0x10,
+            .flags = 0x1403, // Rumble, lightbar and player LEDs
+            .flags2 = 2,
+            .lightbarSetup = 2,
+            .lightbarBlue = 255,
+        };
+        if (_isUSBDualSense) {
+            _lastVendorSpecificOutput.dualsenseOutput.reportIDOnUSB = 1;
+            _lastVendorSpecificOutput.dualsenseOutput.lightbarBlue = 0;
+            _lastVendorSpecificOutput.dualsenseOutput.lightbarGreen = 96;
+            _lastVendorSpecificOutput.dualsenseOutput.lightbarRed = 255;
+
+        }
+        // Send a report to switch the controller to a more capable mode
+        [self sendDualSenseOutput];
+        _lastVendorSpecificOutput.dualsenseOutput.flags2 = 0;
+        _lastVendorSpecificOutput.dualsenseOutput.lightbarSetup = 0;
+    }
     
     _rumbleQueue = dispatch_queue_create([NSString stringWithFormat:@"Rumble Queue for %@", self.deviceName].UTF8String,
                                          NULL);
@@ -723,6 +783,73 @@ typedef union {
     }
 }
 
+- (void) sendDualSenseOutput
+{
+    if (_isUSBDualSense) {
+        [self sendReport:[NSData dataWithBytes:&_lastVendorSpecificOutput.dualsenseOutput.reportIDOnUSB length:_lastVendorSpecificOutput.dualsenseOutput.bluetoothSpecific - &_lastVendorSpecificOutput.dualsenseOutput.reportIDOnUSB]];
+        return;
+    }
+    _lastVendorSpecificOutput.dualsenseOutput.sequence += 0x10;
+    static const uint32_t table[] = {
+        0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
+        0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
+        0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
+        0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
+        0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
+        0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
+        0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
+        0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
+        0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
+        0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
+        0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
+        0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
+        0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
+        0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
+        0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
+        0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
+        0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
+        0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
+        0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
+        0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
+        0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
+        0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
+        0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
+        0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
+        0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
+        0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
+        0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
+        0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
+        0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
+        0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
+        0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
+        0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
+        0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
+        0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
+        0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
+        0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
+        0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
+        0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
+        0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
+        0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
+        0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
+        0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
+        0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
+    };
+    
+    const uint8_t *byte = (void *)&_lastVendorSpecificOutput.dualsenseOutput;
+    uint32_t size = sizeof(_lastVendorSpecificOutput.dualsenseOutput) - 4;
+    uint32_t ret = 0xFFFFFFFF;
+    ret = table[(ret ^ 0xa2) & 0xFF] ^ (ret >> 8);
+
+    while (size--) {
+        ret = table[(ret ^ *byte++) & 0xFF] ^ (ret >> 8);
+    }
+    
+    _lastVendorSpecificOutput.dualsenseOutput.crc32 = ~ret;
+    
+    [self sendReport:[NSData dataWithBytes:&_lastVendorSpecificOutput.dualsenseOutput length:sizeof(_lastVendorSpecificOutput.dualsenseOutput)]];
+}
+
 - (void)setPlayerLEDs:(uint8_t)mask
 {
     mask &= 0xF;
@@ -743,6 +870,10 @@ typedef union {
         _lastVendorSpecificOutput.ds3Output.ledsEnabled = mask << 1;
         [self sendReport:[NSData dataWithBytes:&_lastVendorSpecificOutput.ds3Output length:sizeof(_lastVendorSpecificOutput.ds3Output)]];
     }
+    else if (_isDualSense) {
+        _lastVendorSpecificOutput.dualsenseOutput.playerLEDs = mask;
+        [self sendDualSenseOutput];
+    }
 }
 
 - (void)updateRumble
@@ -750,7 +881,7 @@ typedef union {
     if (!self.connected) {
         return;
     }
-    if (!_rumbleElement && !_isSwitch && !_isDualShock3) {
+    if (!_rumbleElement && !_isSwitch && !_isDualShock3 && !_isDualSense) {
         return;
     }
     if (_rumbleElement.max == 1 && _rumbleElement.min == 0) {
@@ -809,6 +940,11 @@ typedef union {
             _lastVendorSpecificOutput.ds3Output.rumbleLeftStrength = _lastVendorSpecificOutput.ds3Output.rumbleRightStrength = round(_rumbleAmplitude * 0xff);
             [self sendReport:[NSData dataWithBytes:&_lastVendorSpecificOutput.ds3Output length:sizeof(_lastVendorSpecificOutput.ds3Output)]];
         }
+        else if (_isDualSense) {
+            _lastVendorSpecificOutput.dualsenseOutput.rumbleLeftStrength = round(_rumbleAmplitude * _rumbleAmplitude * 0xff);
+            _lastVendorSpecificOutput.dualsenseOutput.rumbleRightStrength = _rumbleAmplitude > 0.25 ? round(pow(_rumbleAmplitude - 0.25, 2) * 0xff) : 0;
+            [self sendDualSenseOutput];
+        }
         else {
             [_rumbleElement setValue:_rumbleAmplitude * (_rumbleElement.max - _rumbleElement.min) + _rumbleElement.min];
         }