From 5a079a2d114f96d4847d1ee305d5b7c16eeec50e Mon Sep 17 00:00:00 2001 From: 3gg <3gg@shellblade.net> Date: Sat, 27 Dec 2025 12:03:39 -0800 Subject: Initial commit --- .../src/joystick/hidapi/SDL_hidapi_gamecube.c | 534 +++++++++++++++++++++ 1 file changed, 534 insertions(+) create mode 100644 contrib/SDL-3.2.8/src/joystick/hidapi/SDL_hidapi_gamecube.c (limited to 'contrib/SDL-3.2.8/src/joystick/hidapi/SDL_hidapi_gamecube.c') diff --git a/contrib/SDL-3.2.8/src/joystick/hidapi/SDL_hidapi_gamecube.c b/contrib/SDL-3.2.8/src/joystick/hidapi/SDL_hidapi_gamecube.c new file mode 100644 index 0000000..4d45c7a --- /dev/null +++ b/contrib/SDL-3.2.8/src/joystick/hidapi/SDL_hidapi_gamecube.c @@ -0,0 +1,534 @@ +/* + Simple DirectMedia Layer + Copyright (C) 1997-2025 Sam Lantinga + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. +*/ +#include "SDL_internal.h" + +#ifdef SDL_JOYSTICK_HIDAPI + +#include "../../SDL_hints_c.h" +#include "../SDL_sysjoystick.h" +#include "SDL_hidapijoystick_c.h" +#include "SDL_hidapi_rumble.h" +#include "../../hidapi/SDL_hidapi_c.h" + +#ifdef SDL_JOYSTICK_HIDAPI_GAMECUBE + +// Define this if you want to log all packets from the controller +// #define DEBUG_GAMECUBE_PROTOCOL + +#define MAX_CONTROLLERS 4 + +typedef struct +{ + bool pc_mode; + SDL_JoystickID joysticks[MAX_CONTROLLERS]; + Uint8 wireless[MAX_CONTROLLERS]; + Uint8 min_axis[MAX_CONTROLLERS * SDL_GAMEPAD_AXIS_COUNT]; + Uint8 max_axis[MAX_CONTROLLERS * SDL_GAMEPAD_AXIS_COUNT]; + Uint8 rumbleAllowed[MAX_CONTROLLERS]; + Uint8 rumble[1 + MAX_CONTROLLERS]; + // Without this variable, hid_write starts to lag a TON + bool rumbleUpdate; + bool useRumbleBrake; +} SDL_DriverGameCube_Context; + +static void HIDAPI_DriverGameCube_RegisterHints(SDL_HintCallback callback, void *userdata) +{ + SDL_AddHintCallback(SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE, callback, userdata); +} + +static void HIDAPI_DriverGameCube_UnregisterHints(SDL_HintCallback callback, void *userdata) +{ + SDL_RemoveHintCallback(SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE, callback, userdata); +} + +static bool HIDAPI_DriverGameCube_IsEnabled(void) +{ + return SDL_GetHintBoolean(SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE, + SDL_GetHintBoolean(SDL_HINT_JOYSTICK_HIDAPI, + SDL_HIDAPI_DEFAULT)); +} + +static bool HIDAPI_DriverGameCube_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) +{ + if (vendor_id == USB_VENDOR_NINTENDO && product_id == USB_PRODUCT_NINTENDO_GAMECUBE_ADAPTER) { + // Nintendo Co., Ltd. Wii U GameCube Controller Adapter + return true; + } + if (vendor_id == USB_VENDOR_DRAGONRISE && + (product_id == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER1 || + product_id == USB_PRODUCT_EVORETRO_GAMECUBE_ADAPTER2)) { + // EVORETRO GameCube Controller Adapter + return true; + } + return false; +} + +static void ResetAxisRange(SDL_DriverGameCube_Context *ctx, int joystick_index) +{ + SDL_memset(&ctx->min_axis[joystick_index * SDL_GAMEPAD_AXIS_COUNT], 128 - 88, SDL_GAMEPAD_AXIS_COUNT); + SDL_memset(&ctx->max_axis[joystick_index * SDL_GAMEPAD_AXIS_COUNT], 128 + 88, SDL_GAMEPAD_AXIS_COUNT); + + // Trigger axes may have a higher resting value + ctx->min_axis[joystick_index * SDL_GAMEPAD_AXIS_COUNT + SDL_GAMEPAD_AXIS_LEFT_TRIGGER] = 40; + ctx->min_axis[joystick_index * SDL_GAMEPAD_AXIS_COUNT + SDL_GAMEPAD_AXIS_RIGHT_TRIGGER] = 40; +} + +static void SDLCALL SDL_JoystickGameCubeRumbleBrakeHintChanged(void *userdata, const char *name, const char *oldValue, const char *hint) +{ + if (hint) { + SDL_DriverGameCube_Context *ctx = (SDL_DriverGameCube_Context *)userdata; + ctx->useRumbleBrake = SDL_GetStringBoolean(hint, false); + } +} + +static bool HIDAPI_DriverGameCube_InitDevice(SDL_HIDAPI_Device *device) +{ + SDL_DriverGameCube_Context *ctx; + Uint8 packet[37]; + Uint8 *curSlot; + Uint8 i; + int size; + Uint8 initMagic = 0x13; + Uint8 rumbleMagic = 0x11; + +#ifdef HAVE_ENABLE_GAMECUBE_ADAPTORS + SDL_EnableGameCubeAdaptors(); +#endif + + ctx = (SDL_DriverGameCube_Context *)SDL_calloc(1, sizeof(*ctx)); + if (!ctx) { + return false; + } + device->context = ctx; + + ctx->joysticks[0] = 0; + ctx->joysticks[1] = 0; + ctx->joysticks[2] = 0; + ctx->joysticks[3] = 0; + ctx->rumble[0] = rumbleMagic; + ctx->useRumbleBrake = false; + + if (device->vendor_id != USB_VENDOR_NINTENDO) { + ctx->pc_mode = true; + } + + if (ctx->pc_mode) { + for (i = 0; i < MAX_CONTROLLERS; ++i) { + ResetAxisRange(ctx, i); + HIDAPI_JoystickConnected(device, &ctx->joysticks[i]); + } + } else { + // This is all that's needed to initialize the device. Really! + if (SDL_hid_write(device->dev, &initMagic, sizeof(initMagic)) != sizeof(initMagic)) { + SDL_LogDebug(SDL_LOG_CATEGORY_INPUT, + "HIDAPI_DriverGameCube_InitDevice(): Couldn't initialize WUP-028"); + return false; + } + + // Wait for the adapter to initialize + SDL_Delay(10); + + // Add all the applicable joysticks + while ((size = SDL_hid_read_timeout(device->dev, packet, sizeof(packet), 0)) > 0) { +#ifdef DEBUG_GAMECUBE_PROTOCOL + HIDAPI_DumpPacket("Nintendo GameCube packet: size = %d", packet, size); +#endif + if (size < 37 || packet[0] != 0x21) { + continue; // Nothing to do yet...? + } + + // Go through all 4 slots + curSlot = packet + 1; + for (i = 0; i < MAX_CONTROLLERS; i += 1, curSlot += 9) { + ctx->wireless[i] = (curSlot[0] & 0x20) != 0; + + // Only allow rumble if the adapter's second USB cable is connected + ctx->rumbleAllowed[i] = (curSlot[0] & 0x04) && !ctx->wireless[i]; + + if (curSlot[0] & 0x30) { // 0x10 - Wired, 0x20 - Wireless + if (ctx->joysticks[i] == 0) { + ResetAxisRange(ctx, i); + HIDAPI_JoystickConnected(device, &ctx->joysticks[i]); + } + } else { + if (ctx->joysticks[i] != 0) { + HIDAPI_JoystickDisconnected(device, ctx->joysticks[i]); + ctx->joysticks[i] = 0; + } + continue; + } + } + } + } + + SDL_AddHintCallback(SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE_RUMBLE_BRAKE, + SDL_JoystickGameCubeRumbleBrakeHintChanged, ctx); + + HIDAPI_SetDeviceName(device, "Nintendo GameCube Controller"); + + return true; +} + +static int HIDAPI_DriverGameCube_GetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_JoystickID instance_id) +{ + SDL_DriverGameCube_Context *ctx = (SDL_DriverGameCube_Context *)device->context; + Uint8 i; + + for (i = 0; i < 4; ++i) { + if (instance_id == ctx->joysticks[i]) { + return i; + } + } + return -1; +} + +static void HIDAPI_DriverGameCube_SetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_JoystickID instance_id, int player_index) +{ +} + +static void HIDAPI_DriverGameCube_HandleJoystickPacket(SDL_HIDAPI_Device *device, SDL_DriverGameCube_Context *ctx, const Uint8 *packet, int size) +{ + SDL_Joystick *joystick; + Uint8 i, v; + Sint16 axis_value; + Uint64 timestamp = SDL_GetTicksNS(); + + if (size != 10) { + return; // How do we handle this packet? + } + + i = packet[0] - 1; + if (i >= MAX_CONTROLLERS) { + return; // How do we handle this packet? + } + + joystick = SDL_GetJoystickFromID(ctx->joysticks[i]); + if (!joystick) { + // Hasn't been opened yet, skip + return; + } + +#define READ_BUTTON(off, flag, button) \ + SDL_SendJoystickButton( \ + timestamp, \ + joystick, \ + button, \ + ((packet[off] & flag) != 0)); + READ_BUTTON(1, 0x02, 0) // A + READ_BUTTON(1, 0x04, 1) // B + READ_BUTTON(1, 0x08, 3) // Y + READ_BUTTON(1, 0x01, 2) // X + READ_BUTTON(2, 0x80, 4) // DPAD_LEFT + READ_BUTTON(2, 0x20, 5) // DPAD_RIGHT + READ_BUTTON(2, 0x40, 6) // DPAD_DOWN + READ_BUTTON(2, 0x10, 7) // DPAD_UP + READ_BUTTON(2, 0x02, 8) // START + READ_BUTTON(1, 0x80, 9) // RIGHTSHOULDER + /* These two buttons are for the bottoms of the analog triggers. + * More than likely, you're going to want to read the axes instead! + * -flibit + */ + READ_BUTTON(1, 0x20, 10) // TRIGGERRIGHT + READ_BUTTON(1, 0x10, 11) // TRIGGERLEFT +#undef READ_BUTTON + +#define READ_AXIS(off, axis, invert) \ + v = invert ? (0xff - packet[off]) : packet[off]; \ + if (v < ctx->min_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis]) \ + ctx->min_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis] = v; \ + if (v > ctx->max_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis]) \ + ctx->max_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis] = v; \ + axis_value = (Sint16)HIDAPI_RemapVal(v, ctx->min_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis], ctx->max_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis], SDL_MIN_SINT16, SDL_MAX_SINT16); \ + SDL_SendJoystickAxis( \ + timestamp, \ + joystick, \ + axis, axis_value); + READ_AXIS(3, SDL_GAMEPAD_AXIS_LEFTX, 0) + READ_AXIS(4, SDL_GAMEPAD_AXIS_LEFTY, 1) + READ_AXIS(6, SDL_GAMEPAD_AXIS_RIGHTX, 0) + READ_AXIS(5, SDL_GAMEPAD_AXIS_RIGHTY, 1) + READ_AXIS(7, SDL_GAMEPAD_AXIS_LEFT_TRIGGER, 0) + READ_AXIS(8, SDL_GAMEPAD_AXIS_RIGHT_TRIGGER, 0) +#undef READ_AXIS +} + +static void HIDAPI_DriverGameCube_HandleNintendoPacket(SDL_HIDAPI_Device *device, SDL_DriverGameCube_Context *ctx, Uint8 *packet, int size) +{ + SDL_Joystick *joystick; + Uint8 *curSlot; + Uint8 i; + Sint16 axis_value; + Uint64 timestamp = SDL_GetTicksNS(); + + if (size < 37 || packet[0] != 0x21) { + return; // Nothing to do right now...? + } + + // Go through all 4 slots + curSlot = packet + 1; + for (i = 0; i < MAX_CONTROLLERS; i += 1, curSlot += 9) { + ctx->wireless[i] = (curSlot[0] & 0x20) != 0; + + // Only allow rumble if the adapter's second USB cable is connected + ctx->rumbleAllowed[i] = (curSlot[0] & 0x04) && !ctx->wireless[i]; + + if (curSlot[0] & 0x30) { // 0x10 - Wired, 0x20 - Wireless + if (ctx->joysticks[i] == 0) { + ResetAxisRange(ctx, i); + HIDAPI_JoystickConnected(device, &ctx->joysticks[i]); + } + joystick = SDL_GetJoystickFromID(ctx->joysticks[i]); + + // Hasn't been opened yet, skip + if (!joystick) { + continue; + } + } else { + if (ctx->joysticks[i] != 0) { + HIDAPI_JoystickDisconnected(device, ctx->joysticks[i]); + ctx->joysticks[i] = 0; + } + continue; + } + +#define READ_BUTTON(off, flag, button) \ + SDL_SendJoystickButton( \ + timestamp, \ + joystick, \ + button, \ + ((curSlot[off] & flag) != 0)); + READ_BUTTON(1, 0x01, 0) // A + READ_BUTTON(1, 0x02, 1) // B + READ_BUTTON(1, 0x04, 2) // X + READ_BUTTON(1, 0x08, 3) // Y + READ_BUTTON(1, 0x10, 4) // DPAD_LEFT + READ_BUTTON(1, 0x20, 5) // DPAD_RIGHT + READ_BUTTON(1, 0x40, 6) // DPAD_DOWN + READ_BUTTON(1, 0x80, 7) // DPAD_UP + READ_BUTTON(2, 0x01, 8) // START + READ_BUTTON(2, 0x02, 9) // RIGHTSHOULDER + /* These two buttons are for the bottoms of the analog triggers. + * More than likely, you're going to want to read the axes instead! + * -flibit + */ + READ_BUTTON(2, 0x04, 10) // TRIGGERRIGHT + READ_BUTTON(2, 0x08, 11) // TRIGGERLEFT +#undef READ_BUTTON + +#define READ_AXIS(off, axis) \ + if (curSlot[off] < ctx->min_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis]) \ + ctx->min_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis] = curSlot[off]; \ + if (curSlot[off] > ctx->max_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis]) \ + ctx->max_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis] = curSlot[off]; \ + axis_value = (Sint16)HIDAPI_RemapVal(curSlot[off], ctx->min_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis], ctx->max_axis[i * SDL_GAMEPAD_AXIS_COUNT + axis], SDL_MIN_SINT16, SDL_MAX_SINT16); \ + SDL_SendJoystickAxis( \ + timestamp, \ + joystick, \ + axis, axis_value); + READ_AXIS(3, SDL_GAMEPAD_AXIS_LEFTX) + READ_AXIS(4, SDL_GAMEPAD_AXIS_LEFTY) + READ_AXIS(5, SDL_GAMEPAD_AXIS_RIGHTX) + READ_AXIS(6, SDL_GAMEPAD_AXIS_RIGHTY) + READ_AXIS(7, SDL_GAMEPAD_AXIS_LEFT_TRIGGER) + READ_AXIS(8, SDL_GAMEPAD_AXIS_RIGHT_TRIGGER) +#undef READ_AXIS + } +} + +static bool HIDAPI_DriverGameCube_UpdateDevice(SDL_HIDAPI_Device *device) +{ + SDL_DriverGameCube_Context *ctx = (SDL_DriverGameCube_Context *)device->context; + Uint8 packet[USB_PACKET_LENGTH]; + int size; + + // Read input packet + while ((size = SDL_hid_read_timeout(device->dev, packet, sizeof(packet), 0)) > 0) { +#ifdef DEBUG_GAMECUBE_PROTOCOL + HIDAPI_DumpPacket("Nintendo GameCube packet: size = %d", packet, size); +#endif + if (ctx->pc_mode) { + HIDAPI_DriverGameCube_HandleJoystickPacket(device, ctx, packet, size); + } else { + HIDAPI_DriverGameCube_HandleNintendoPacket(device, ctx, packet, size); + } + } + + // Write rumble packet + if (ctx->rumbleUpdate) { + SDL_HIDAPI_SendRumble(device, ctx->rumble, sizeof(ctx->rumble)); + ctx->rumbleUpdate = false; + } + + // If we got here, nothing bad happened! + return true; +} + +static bool HIDAPI_DriverGameCube_OpenJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick) +{ + SDL_DriverGameCube_Context *ctx = (SDL_DriverGameCube_Context *)device->context; + Uint8 i; + + SDL_AssertJoysticksLocked(); + + for (i = 0; i < MAX_CONTROLLERS; i += 1) { + if (joystick->instance_id == ctx->joysticks[i]) { + joystick->nbuttons = 12; + joystick->naxes = SDL_GAMEPAD_AXIS_COUNT; + if (ctx->wireless[i]) { + joystick->connection_state = SDL_JOYSTICK_CONNECTION_WIRELESS; + } else { + joystick->connection_state = SDL_JOYSTICK_CONNECTION_WIRED; + } + return true; + } + } + return false; // Should never get here! +} + +static bool HIDAPI_DriverGameCube_RumbleJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble) +{ + SDL_DriverGameCube_Context *ctx = (SDL_DriverGameCube_Context *)device->context; + Uint8 i, val; + + SDL_AssertJoysticksLocked(); + + if (ctx->pc_mode) { + return SDL_Unsupported(); + } + + for (i = 0; i < MAX_CONTROLLERS; i += 1) { + if (joystick->instance_id == ctx->joysticks[i]) { + if (ctx->wireless[i]) { + return SDL_SetError("Nintendo GameCube WaveBird controllers do not support rumble"); + } + if (!ctx->rumbleAllowed[i]) { + return SDL_SetError("Second USB cable for WUP-028 not connected"); + } + if (ctx->useRumbleBrake) { + if (low_frequency_rumble == 0 && high_frequency_rumble > 0) { + val = 0; // if only low is 0 we want to do a regular stop + } else if (low_frequency_rumble == 0 && high_frequency_rumble == 0) { + val = 2; // if both frequencies are 0 we want to do a hard stop + } else { + val = 1; // normal rumble + } + } else { + val = (low_frequency_rumble > 0 || high_frequency_rumble > 0); + } + if (val != ctx->rumble[i + 1]) { + ctx->rumble[i + 1] = val; + ctx->rumbleUpdate = true; + } + return true; + } + } + + // Should never get here! + return SDL_SetError("Couldn't find joystick"); +} + +static bool HIDAPI_DriverGameCube_RumbleJoystickTriggers(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble) +{ + return SDL_Unsupported(); +} + +static Uint32 HIDAPI_DriverGameCube_GetJoystickCapabilities(SDL_HIDAPI_Device *device, SDL_Joystick *joystick) +{ + SDL_DriverGameCube_Context *ctx = (SDL_DriverGameCube_Context *)device->context; + Uint32 result = 0; + + SDL_AssertJoysticksLocked(); + + if (!ctx->pc_mode) { + Uint8 i; + + for (i = 0; i < MAX_CONTROLLERS; i += 1) { + if (joystick->instance_id == ctx->joysticks[i]) { + if (!ctx->wireless[i] && ctx->rumbleAllowed[i]) { + result |= SDL_JOYSTICK_CAP_RUMBLE; + break; + } + } + } + } + + return result; +} + +static bool HIDAPI_DriverGameCube_SetJoystickLED(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue) +{ + return SDL_Unsupported(); +} + +static bool HIDAPI_DriverGameCube_SendJoystickEffect(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, const void *data, int size) +{ + return SDL_Unsupported(); +} + +static bool HIDAPI_DriverGameCube_SetJoystickSensorsEnabled(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, bool enabled) +{ + return SDL_Unsupported(); +} + +static void HIDAPI_DriverGameCube_CloseJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick) +{ + SDL_DriverGameCube_Context *ctx = (SDL_DriverGameCube_Context *)device->context; + + // Stop rumble activity + if (ctx->rumbleUpdate) { + SDL_HIDAPI_SendRumble(device, ctx->rumble, sizeof(ctx->rumble)); + ctx->rumbleUpdate = false; + } +} + +static void HIDAPI_DriverGameCube_FreeDevice(SDL_HIDAPI_Device *device) +{ + SDL_DriverGameCube_Context *ctx = (SDL_DriverGameCube_Context *)device->context; + + SDL_RemoveHintCallback(SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE_RUMBLE_BRAKE, + SDL_JoystickGameCubeRumbleBrakeHintChanged, ctx); +} + +SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverGameCube = { + SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE, + true, + HIDAPI_DriverGameCube_RegisterHints, + HIDAPI_DriverGameCube_UnregisterHints, + HIDAPI_DriverGameCube_IsEnabled, + HIDAPI_DriverGameCube_IsSupportedDevice, + HIDAPI_DriverGameCube_InitDevice, + HIDAPI_DriverGameCube_GetDevicePlayerIndex, + HIDAPI_DriverGameCube_SetDevicePlayerIndex, + HIDAPI_DriverGameCube_UpdateDevice, + HIDAPI_DriverGameCube_OpenJoystick, + HIDAPI_DriverGameCube_RumbleJoystick, + HIDAPI_DriverGameCube_RumbleJoystickTriggers, + HIDAPI_DriverGameCube_GetJoystickCapabilities, + HIDAPI_DriverGameCube_SetJoystickLED, + HIDAPI_DriverGameCube_SendJoystickEffect, + HIDAPI_DriverGameCube_SetJoystickSensorsEnabled, + HIDAPI_DriverGameCube_CloseJoystick, + HIDAPI_DriverGameCube_FreeDevice, +}; + +#endif // SDL_JOYSTICK_HIDAPI_GAMECUBE + +#endif // SDL_JOYSTICK_HIDAPI -- cgit v1.2.3