/*
|
Simple DirectMedia Layer
|
Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
|
|
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.h"
|
#include "SDL_events.h"
|
#include "SDL_timer.h"
|
#include "SDL_joystick.h"
|
#include "SDL_gamecontroller.h"
|
#include "../SDL_sysjoystick.h"
|
#include "SDL_hidapijoystick_c.h"
|
#include "SDL_hidapi_rumble.h"
|
|
|
#ifdef SDL_JOYSTICK_HIDAPI_XBOX360
|
|
/* Define this if you want to log all packets from the controller */
|
/*#define DEBUG_XBOX_PROTOCOL*/
|
|
|
typedef struct {
|
Uint8 last_state[USB_PACKET_LENGTH];
|
} SDL_DriverXbox360_Context;
|
|
#if defined(__MACOSX__)
|
static SDL_bool
|
IsBluetoothXboxOneController(Uint16 vendor_id, Uint16 product_id)
|
{
|
/* Check to see if it's the Xbox One S or Xbox One Elite Series 2 in Bluetooth mode */
|
if (vendor_id == USB_VENDOR_MICROSOFT) {
|
if (product_id == USB_PRODUCT_XBOX_ONE_S_REV1_BLUETOOTH ||
|
product_id == USB_PRODUCT_XBOX_ONE_S_REV2_BLUETOOTH ||
|
product_id == USB_PRODUCT_XBOX_ONE_ELITE_SERIES_2_BLUETOOTH) {
|
return SDL_TRUE;
|
}
|
}
|
return SDL_FALSE;
|
}
|
#endif
|
|
static SDL_bool
|
HIDAPI_DriverXbox360_IsSupportedDevice(const char *name, SDL_GameControllerType type, Uint16 vendor_id, Uint16 product_id, Uint16 version, int interface_number, int interface_class, int interface_subclass, int interface_protocol)
|
{
|
const int XB360W_IFACE_PROTOCOL = 129; /* Wireless */
|
|
if (vendor_id == USB_VENDOR_NVIDIA) {
|
/* This is the NVIDIA Shield controller which doesn't talk Xbox controller protocol */
|
return SDL_FALSE;
|
}
|
if ((vendor_id == USB_VENDOR_MICROSOFT && (product_id == 0x0291 || product_id == 0x0719)) ||
|
(type == SDL_CONTROLLER_TYPE_XBOX360 && interface_protocol == XB360W_IFACE_PROTOCOL)) {
|
/* This is the wireless dongle, which talks a different protocol */
|
return SDL_FALSE;
|
}
|
if (interface_number > 0) {
|
/* This is the chatpad or other input interface, not the Xbox 360 interface */
|
return SDL_FALSE;
|
}
|
#if defined(__MACOSX__) || defined(__WIN32__)
|
if (vendor_id == USB_VENDOR_MICROSOFT && product_id == 0x028e && version == 1) {
|
/* This is the Steam Virtual Gamepad, which isn't supported by this driver */
|
return SDL_FALSE;
|
}
|
#endif
|
#if defined(__MACOSX__)
|
/* 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 (IsBluetoothXboxOneController(vendor_id, product_id)) {
|
return SDL_FALSE;
|
}
|
return (type == SDL_CONTROLLER_TYPE_XBOX360 || type == SDL_CONTROLLER_TYPE_XBOXONE) ? SDL_TRUE : SDL_FALSE;
|
#else
|
return (type == SDL_CONTROLLER_TYPE_XBOX360) ? SDL_TRUE : SDL_FALSE;
|
#endif
|
}
|
|
static const char *
|
HIDAPI_DriverXbox360_GetDeviceName(Uint16 vendor_id, Uint16 product_id)
|
{
|
return NULL;
|
}
|
|
static SDL_bool SetSlotLED(hid_device *dev, Uint8 slot)
|
{
|
Uint8 mode = 0x02 + slot;
|
const Uint8 led_packet[] = { 0x01, 0x03, mode };
|
|
if (hid_write(dev, led_packet, sizeof(led_packet)) != sizeof(led_packet)) {
|
return SDL_FALSE;
|
}
|
return SDL_TRUE;
|
}
|
|
static SDL_bool
|
HIDAPI_DriverXbox360_InitDevice(SDL_HIDAPI_Device *device)
|
{
|
return HIDAPI_JoystickConnected(device, NULL);
|
}
|
|
static int
|
HIDAPI_DriverXbox360_GetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_JoystickID instance_id)
|
{
|
return -1;
|
}
|
|
static void
|
HIDAPI_DriverXbox360_SetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_JoystickID instance_id, int player_index)
|
{
|
if (!device->dev) {
|
return;
|
}
|
SetSlotLED(device->dev, (player_index % 4));
|
}
|
|
static SDL_bool
|
HIDAPI_DriverXbox360_OpenJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
|
{
|
SDL_DriverXbox360_Context *ctx;
|
int player_index;
|
|
ctx = (SDL_DriverXbox360_Context *)SDL_calloc(1, sizeof(*ctx));
|
if (!ctx) {
|
SDL_OutOfMemory();
|
return SDL_FALSE;
|
}
|
|
device->dev = hid_open_path(device->path, 0);
|
if (!device->dev) {
|
SDL_SetError("Couldn't open %s", device->path);
|
SDL_free(ctx);
|
return SDL_FALSE;
|
}
|
device->context = ctx;
|
|
/* Set the controller LED */
|
player_index = SDL_JoystickGetPlayerIndex(joystick);
|
if (player_index >= 0) {
|
SetSlotLED(device->dev, (player_index % 4));
|
}
|
|
/* Initialize the joystick capabilities */
|
joystick->nbuttons = 15;
|
joystick->naxes = SDL_CONTROLLER_AXIS_MAX;
|
joystick->epowerlevel = SDL_JOYSTICK_POWER_WIRED;
|
|
return SDL_TRUE;
|
}
|
|
static int
|
HIDAPI_DriverXbox360_RumbleJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble)
|
{
|
#ifdef __MACOSX__
|
if (IsBluetoothXboxOneController(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 Mac OS X 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);
|
rumble_packet[4] = (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");
|
}
|
#endif
|
return 0;
|
}
|
|
static int
|
HIDAPI_DriverXbox360_RumbleJoystickTriggers(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble)
|
{
|
return SDL_Unsupported();
|
}
|
|
static SDL_bool
|
HIDAPI_DriverXbox360_HasJoystickLED(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
|
{
|
/* Doesn't have an RGB LED, so don't return true here */
|
return SDL_FALSE;
|
}
|
|
static int
|
HIDAPI_DriverXbox360_SetJoystickLED(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue)
|
{
|
return SDL_Unsupported();
|
}
|
|
static int
|
HIDAPI_DriverXbox360_SetJoystickSensorsEnabled(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, SDL_bool enabled)
|
{
|
return SDL_Unsupported();
|
}
|
|
static void
|
HIDAPI_DriverXbox360_HandleStatePacket(SDL_Joystick *joystick, SDL_DriverXbox360_Context *ctx, Uint8 *data, int size)
|
{
|
Sint16 axis;
|
#ifdef __MACOSX__
|
const SDL_bool invert_y_axes = SDL_FALSE;
|
#else
|
const SDL_bool invert_y_axes = SDL_TRUE;
|
#endif
|
|
if (ctx->last_state[2] != data[2]) {
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_UP, (data[2] & 0x01) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_DOWN, (data[2] & 0x02) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_LEFT, (data[2] & 0x04) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_RIGHT, (data[2] & 0x08) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_START, (data[2] & 0x10) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_BACK, (data[2] & 0x20) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_LEFTSTICK, (data[2] & 0x40) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_RIGHTSTICK, (data[2] & 0x80) ? SDL_PRESSED : SDL_RELEASED);
|
}
|
|
if (ctx->last_state[3] != data[3]) {
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_LEFTSHOULDER, (data[3] & 0x01) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_RIGHTSHOULDER, (data[3] & 0x02) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_GUIDE, (data[3] & 0x04) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_A, (data[3] & 0x10) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_B, (data[3] & 0x20) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_X, (data[3] & 0x40) ? SDL_PRESSED : SDL_RELEASED);
|
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_Y, (data[3] & 0x80) ? SDL_PRESSED : SDL_RELEASED);
|
}
|
|
axis = ((int)data[4] * 257) - 32768;
|
SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_TRIGGERLEFT, axis);
|
axis = ((int)data[5] * 257) - 32768;
|
SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_TRIGGERRIGHT, axis);
|
axis = *(Sint16*)(&data[6]);
|
SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_LEFTX, axis);
|
axis = *(Sint16*)(&data[8]);
|
if (invert_y_axes) {
|
axis = ~axis;
|
}
|
SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_LEFTY, axis);
|
axis = *(Sint16*)(&data[10]);
|
SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_RIGHTX, axis);
|
axis = *(Sint16*)(&data[12]);
|
if (invert_y_axes) {
|
axis = ~axis;
|
}
|
SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_RIGHTY, axis);
|
|
SDL_memcpy(ctx->last_state, data, SDL_min(size, sizeof(ctx->last_state)));
|
}
|
|
static SDL_bool
|
HIDAPI_DriverXbox360_UpdateDevice(SDL_HIDAPI_Device *device)
|
{
|
SDL_DriverXbox360_Context *ctx = (SDL_DriverXbox360_Context *)device->context;
|
SDL_Joystick *joystick = NULL;
|
Uint8 data[USB_PACKET_LENGTH];
|
int size = 0;
|
|
if (device->num_joysticks > 0) {
|
joystick = SDL_JoystickFromInstanceID(device->joysticks[0]);
|
}
|
if (!joystick) {
|
return SDL_FALSE;
|
}
|
|
while ((size = hid_read_timeout(device->dev, data, sizeof(data), 0)) > 0) {
|
#ifdef DEBUG_XBOX_PROTOCOL
|
HIDAPI_DumpPacket("Xbox 360 packet: size = %d", data, size);
|
#endif
|
if (data[0] == 0x00) {
|
HIDAPI_DriverXbox360_HandleStatePacket(joystick, ctx, data, size);
|
}
|
}
|
|
if (size < 0) {
|
/* Read error, device is disconnected */
|
HIDAPI_JoystickDisconnected(device, joystick->instance_id);
|
}
|
return (size >= 0);
|
}
|
|
static void
|
HIDAPI_DriverXbox360_CloseJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
|
{
|
if (device->dev) {
|
hid_close(device->dev);
|
device->dev = NULL;
|
}
|
|
SDL_free(device->context);
|
device->context = NULL;
|
}
|
|
static void
|
HIDAPI_DriverXbox360_FreeDevice(SDL_HIDAPI_Device *device)
|
{
|
}
|
|
SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverXbox360 =
|
{
|
SDL_HINT_JOYSTICK_HIDAPI_XBOX,
|
SDL_TRUE,
|
HIDAPI_DriverXbox360_IsSupportedDevice,
|
HIDAPI_DriverXbox360_GetDeviceName,
|
HIDAPI_DriverXbox360_InitDevice,
|
HIDAPI_DriverXbox360_GetDevicePlayerIndex,
|
HIDAPI_DriverXbox360_SetDevicePlayerIndex,
|
HIDAPI_DriverXbox360_UpdateDevice,
|
HIDAPI_DriverXbox360_OpenJoystick,
|
HIDAPI_DriverXbox360_RumbleJoystick,
|
HIDAPI_DriverXbox360_RumbleJoystickTriggers,
|
HIDAPI_DriverXbox360_HasJoystickLED,
|
HIDAPI_DriverXbox360_SetJoystickLED,
|
HIDAPI_DriverXbox360_SetJoystickSensorsEnabled,
|
HIDAPI_DriverXbox360_CloseJoystick,
|
HIDAPI_DriverXbox360_FreeDevice,
|
};
|
|
#endif /* SDL_JOYSTICK_HIDAPI_XBOX360 */
|
|
#endif /* SDL_JOYSTICK_HIDAPI */
|
|
/* vi: set ts=4 sw=4 expandtab: */
|
