From 7da728a642f2acfbba9543a3587363908d7aa1c3 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Mon, 7 Oct 2024 15:42:55 -0700
Subject: [PATCH] Added support for wired XBox controllers on macOS 15.0
Sequoia
Fixes https://github.com/libsdl-org/SDL/issues/11002
---
src/joystick/apple/SDL_mfijoystick.m | 3 +-
src/joystick/darwin/SDL_iokitjoystick.c | 5 +++
src/joystick/hidapi/SDL_hidapi_xbox360.c | 48 ++----------------------
src/joystick/hidapi/SDL_hidapi_xboxone.c | 11 ++++--
4 files changed, 18 insertions(+), 49 deletions(-)
diff --git a/src/joystick/apple/SDL_mfijoystick.m b/src/joystick/apple/SDL_mfijoystick.m
index a11176803c64a..6f14991d642c4 100644
--- a/src/joystick/apple/SDL_mfijoystick.m
+++ b/src/joystick/apple/SDL_mfijoystick.m
@@ -392,7 +392,8 @@ static bool IOS_AddMFIJoystickDevice(SDL_JoystickDeviceItem *device, GCControlle
device->is_switch_joyconL = IsControllerSwitchJoyConL(controller);
device->is_switch_joyconR = IsControllerSwitchJoyConR(controller);
#ifdef SDL_JOYSTICK_HIDAPI
- if ((device->is_xbox && HIDAPI_IsDeviceTypePresent(SDL_GAMEPAD_TYPE_XBOXONE)) ||
+ if ((device->is_xbox && (HIDAPI_IsDeviceTypePresent(SDL_GAMEPAD_TYPE_XBOXONE) ||
+ HIDAPI_IsDeviceTypePresent(SDL_GAMEPAD_TYPE_XBOX360))) ||
(device->is_ps4 && HIDAPI_IsDeviceTypePresent(SDL_GAMEPAD_TYPE_PS4)) ||
(device->is_ps5 && HIDAPI_IsDeviceTypePresent(SDL_GAMEPAD_TYPE_PS5)) ||
(device->is_switch_pro && HIDAPI_IsDeviceTypePresent(SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_PRO)) ||
diff --git a/src/joystick/darwin/SDL_iokitjoystick.c b/src/joystick/darwin/SDL_iokitjoystick.c
index c558aa7e8a44f..c51a558090736 100644
--- a/src/joystick/darwin/SDL_iokitjoystick.c
+++ b/src/joystick/darwin/SDL_iokitjoystick.c
@@ -475,6 +475,11 @@ static bool GetDeviceInfo(IOHIDDeviceRef hidDevice, recDevice *pDevice)
CFNumberGetValue(refCF, kCFNumberSInt32Type, &version);
}
+ if (SDL_IsJoystickXboxOne(vendor, product)) {
+ // We can't actually use this API for Xbox controllers
+ return false;
+ }
+
// get device name
refCF = IOHIDDeviceGetProperty(hidDevice, CFSTR(kIOHIDManufacturerKey));
if ((!refCF) || (!CFStringGetCString(refCF, manufacturer_string, sizeof(manufacturer_string), kCFStringEncodingUTF8))) {
diff --git a/src/joystick/hidapi/SDL_hidapi_xbox360.c b/src/joystick/hidapi/SDL_hidapi_xbox360.c
index f7217233a5102..6d47f0d0662f2 100644
--- a/src/joystick/hidapi/SDL_hidapi_xbox360.c
+++ b/src/joystick/hidapi/SDL_hidapi_xbox360.c
@@ -80,21 +80,10 @@ static bool HIDAPI_DriverXbox360_IsSupportedDevice(SDL_HIDAPI_Device *device, co
// This is the chatpad or other input interface, not the Xbox 360 interface
return false;
}
-#ifdef SDL_PLATFORM_MACOS
- if (vendor_id == USB_VENDOR_MICROSOFT && product_id == USB_PRODUCT_XBOX360_WIRED_CONTROLLER && version == 0) {
- // This is the Steam Virtual Gamepad, which isn't supported by this driver
- return false;
- }
- /* Wired Xbox One controllers are handled by this driver, interfacing with
- the 360Controller driver available from:
- https://github.com/360Controller/360Controller/releases
-
- Bluetooth Xbox One controllers are handled by the SDL Xbox One driver
- */
- if (SDL_IsJoystickBluetoothXboxOne(vendor_id, product_id)) {
- return false;
- }
- return (type == SDL_GAMEPAD_TYPE_XBOX360 || type == SDL_GAMEPAD_TYPE_XBOXONE);
+#if defined(SDL_PLATFORM_MACOS) && defined(SDL_JOYSTICK_MFI)
+ // On macOS you can't write output reports to wired XBox controllers,
+ // so we'll just use the GCController support instead.
+ return false;
#else
return (type == SDL_GAMEPAD_TYPE_XBOX360);
#endif
@@ -197,30 +186,6 @@ static bool HIDAPI_DriverXbox360_OpenJoystick(SDL_HIDAPI_Device *device, SDL_Joy
static bool HIDAPI_DriverXbox360_RumbleJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble)
{
-#ifdef SDL_PLATFORM_MACOS
- if (SDL_IsJoystickBluetoothXboxOne(device->vendor_id, device->product_id)) {
- Uint8 rumble_packet[] = { 0x03, 0x0F, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00 };
-
- rumble_packet[4] = (low_frequency_rumble >> 8);
- rumble_packet[5] = (high_frequency_rumble >> 8);
-
- if (SDL_HIDAPI_SendRumble(device, rumble_packet, sizeof(rumble_packet)) != sizeof(rumble_packet)) {
- return SDL_SetError("Couldn't send rumble packet");
- }
- } else {
- /* On macOS the 360Controller driver uses this short report,
- and we need to prefix it with a magic token so hidapi passes it through untouched
- */
- Uint8 rumble_packet[] = { 'M', 'A', 'G', 'I', 'C', '0', 0x00, 0x04, 0x00, 0x00 };
-
- rumble_packet[6 + 2] = (low_frequency_rumble >> 8);
- rumble_packet[6 + 3] = (high_frequency_rumble >> 8);
-
- if (SDL_HIDAPI_SendRumble(device, rumble_packet, sizeof(rumble_packet)) != sizeof(rumble_packet)) {
- return SDL_SetError("Couldn't send rumble packet");
- }
- }
-#else
Uint8 rumble_packet[] = { 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
rumble_packet[3] = (low_frequency_rumble >> 8);
@@ -229,7 +194,6 @@ static bool HIDAPI_DriverXbox360_RumbleJoystick(SDL_HIDAPI_Device *device, SDL_J
if (SDL_HIDAPI_SendRumble(device, rumble_packet, sizeof(rumble_packet)) != sizeof(rumble_packet)) {
return SDL_SetError("Couldn't send rumble packet");
}
-#endif
return true;
}
@@ -267,11 +231,7 @@ static bool HIDAPI_DriverXbox360_SetJoystickSensorsEnabled(SDL_HIDAPI_Device *de
static void HIDAPI_DriverXbox360_HandleStatePacket(SDL_Joystick *joystick, SDL_DriverXbox360_Context *ctx, Uint8 *data, int size)
{
Sint16 axis;
-#ifdef SDL_PLATFORM_MACOS
- const bool invert_y_axes = false;
-#else
const bool invert_y_axes = true;
-#endif
Uint64 timestamp = SDL_GetTicksNS();
if (ctx->last_state[2] != data[2]) {
diff --git a/src/joystick/hidapi/SDL_hidapi_xboxone.c b/src/joystick/hidapi/SDL_hidapi_xboxone.c
index 0ae820ddc89f4..6f5c47532afb4 100644
--- a/src/joystick/hidapi/SDL_hidapi_xboxone.c
+++ b/src/joystick/hidapi/SDL_hidapi_xboxone.c
@@ -350,9 +350,11 @@ static bool HIDAPI_DriverXboxOne_IsEnabled(void)
static bool HIDAPI_DriverXboxOne_IsSupportedDevice(SDL_HIDAPI_Device *device, const char *name, SDL_GamepadType type, Uint16 vendor_id, Uint16 product_id, Uint16 version, int interface_number, int interface_class, int interface_subclass, int interface_protocol)
{
-#ifdef SDL_PLATFORM_MACOS
- // Wired Xbox One controllers are handled by the 360Controller driver
+#if defined(SDL_PLATFORM_MACOS) && defined(SDL_JOYSTICK_MFI)
if (!SDL_IsJoystickBluetoothXboxOne(vendor_id, product_id)) {
+ // On macOS we get a shortened version of the real report and
+ // you can't write output reports for wired controllers, so
+ // we'll just use the GCController support instead.
return false;
}
#endif
@@ -1552,8 +1554,9 @@ static bool HIDAPI_GIP_ProcessData(SDL_Joystick *joystick, SDL_DriverXboxOne_Con
while (size > GIP_HEADER_MIN_LENGTH) {
hdr_len = HIDAPI_GIP_DecodeHeader(&hdr, data, size);
- if ((hdr_len + hdr.packet_length) > (size_t)size) {
- return false;
+ if ((hdr_len + hdr.packet_length) > (Uint32)size) {
+ // On macOS we get a shortened version of the real report
+ hdr.packet_length = (Uint32)(size - hdr_len);
}
if (!HIDAPI_GIP_ProcessPacket(joystick, ctx, &hdr, data + hdr_len)) {