/*

Simple DirectMedia Layer

Copyright (C) 1997-2018 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_log.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"

#ifdef SDL_JOYSTICK_HIDAPI_XBOXONE

#define USB_PACKET_LENGTH 64

typedef struct

{

Uint16 vendor_id;

Uint16 product_id;

const char *name;

} SDL_DriverXboxOne_DeviceName;

static const SDL_DriverXboxOne_DeviceName xboxone_devicenames[] = {

{ 0x045e, 0x02d1, "Microsoft X-Box One pad" },

{ 0x045e, 0x02dd, "Microsoft X-Box One pad (Firmware 2015)" },

{ 0x045e, 0x02e3, "Microsoft X-Box One Elite pad" },

{ 0x045e, 0x02ea, "Microsoft X-Box One S pad" },

{ 0x045e, 0x02ff, "Microsoft X-Box One pad" },

{ 0x0738, 0x4a01, "Mad Catz FightStick TE 2" },

{ 0x0e6f, 0x0139, "Afterglow Prismatic Wired Controller" },

{ 0x0e6f, 0x013a, "PDP Xbox One Controller" },

{ 0x0e6f, 0x0146, "Rock Candy Wired Controller for Xbox One" },

{ 0x0e6f, 0x0147, "PDP Marvel Xbox One Controller" },

{ 0x0e6f, 0x015c, "PDP Xbox One Arcade Stick" },

{ 0x0e6f, 0x0161, "PDP Xbox One Controller" },

{ 0x0e6f, 0x0162, "PDP Xbox One Controller" },

{ 0x0e6f, 0x0163, "PDP Xbox One Controller" },

{ 0x0e6f, 0x0164, "PDP Battlefield One" },

{ 0x0e6f, 0x0165, "PDP Titanfall 2" },

{ 0x0e6f, 0x0246, "Rock Candy Gamepad for Xbox One 2015" },

{ 0x0e6f, 0x02ab, "PDP Controller for Xbox One" },

{ 0x0e6f, 0x02a4, "PDP Wired Controller for Xbox One - Stealth Series" },

{ 0x0e6f, 0x0346, "Rock Candy Gamepad for Xbox One 2016" },

{ 0x0f0d, 0x0063, "Hori Real Arcade Pro Hayabusa (USA) Xbox One" },

{ 0x0f0d, 0x0067, "HORIPAD ONE" },

{ 0x0f0d, 0x0078, "Hori Real Arcade Pro V Kai Xbox One" },

{ 0x1532, 0x0a00, "Razer Atrox Arcade Stick" },

{ 0x1532, 0x0a03, "Razer Wildcat" },

{ 0x24c6, 0x541a, "PowerA Xbox One Mini Wired Controller" },

{ 0x24c6, 0x542a, "Xbox ONE spectra" },

{ 0x24c6, 0x543a, "PowerA Xbox One wired controller" },

{ 0x24c6, 0x551a, "PowerA FUSION Pro Controller" },

{ 0x24c6, 0x561a, "PowerA FUSION Controller" },

};

/*

* This packet is required for all Xbox One pads with 2015

* or later firmware installed (or present from the factory).

*/

static const Uint8 xboxone_fw2015_init[] = {

0x05, 0x20, 0x00, 0x01, 0x00

};

/*

* This packet is required for the Titanfall 2 Xbox One pads

* (0x0e6f:0x0165) to finish initialization and for Hori pads

* (0x0f0d:0x0067) to make the analog sticks work.

*/

static const Uint8 xboxone_hori_init[] = {

0x01, 0x20, 0x00, 0x09, 0x00, 0x04, 0x20, 0x3a,

0x00, 0x00, 0x00, 0x80, 0x00

};

/*

* This packet is required for some of the PDP pads to start

* sending input reports. These pads include: (0x0e6f:0x02ab),

* (0x0e6f:0x02a4).

*/

static const Uint8 xboxone_pdp_init1[] = {

0x0a, 0x20, 0x00, 0x03, 0x00, 0x01, 0x14

};

/*

* This packet is required for some of the PDP pads to start

* sending input reports. These pads include: (0x0e6f:0x02ab),

* (0x0e6f:0x02a4).

*/

static const Uint8 xboxone_pdp_init2[] = {

0x06, 0x20, 0x00, 0x02, 0x01, 0x00

};

/*

* A specific rumble packet is required for some PowerA pads to start

* sending input reports. One of those pads is (0x24c6:0x543a).

*/

static const Uint8 xboxone_rumblebegin_init[] = {

0x09, 0x00, 0x00, 0x09, 0x00, 0x0F, 0x00, 0x00,

0x1D, 0x1D, 0xFF, 0x00, 0x00

};

/*

* A rumble packet with zero FF intensity will immediately

* terminate the rumbling required to init PowerA pads.

* This should happen fast enough that the motors don't

* spin up to enough speed to actually vibrate the gamepad.

*/

static const Uint8 xboxone_rumbleend_init[] = {

0x09, 0x00, 0x00, 0x09, 0x00, 0x0F, 0x00, 0x00,

0x00, 0x00, 0x00, 0x00, 0x00

};

/*

* This specifies the selection of init packets that a gamepad

* will be sent on init *and* the order in which they will be

* sent. The correct sequence number will be added when the

* packet is going to be sent.

*/

typedef struct {

Uint16 vendor_id;

Uint16 product_id;

const Uint8 *data;

int size;

} SDL_DriverXboxOne_InitPacket;

static const SDL_DriverXboxOne_InitPacket xboxone_init_packets[] = {

{ 0x0e6f, 0x0165, xboxone_hori_init, sizeof(xboxone_hori_init) },

{ 0x0f0d, 0x0067, xboxone_hori_init, sizeof(xboxone_hori_init) },

{ 0x0000, 0x0000, xboxone_fw2015_init, sizeof(xboxone_fw2015_init) },

{ 0x0e6f, 0x0246, xboxone_pdp_init1, sizeof(xboxone_pdp_init1) },

{ 0x0e6f, 0x0246, xboxone_pdp_init2, sizeof(xboxone_pdp_init2) },

{ 0x0e6f, 0x02ab, xboxone_pdp_init1, sizeof(xboxone_pdp_init1) },

{ 0x0e6f, 0x02ab, xboxone_pdp_init2, sizeof(xboxone_pdp_init2) },

{ 0x0e6f, 0x02a4, xboxone_pdp_init1, sizeof(xboxone_pdp_init1) },

{ 0x0e6f, 0x02a4, xboxone_pdp_init2, sizeof(xboxone_pdp_init2) },

{ 0x24c6, 0x541a, xboxone_rumblebegin_init, sizeof(xboxone_rumblebegin_init) },

{ 0x24c6, 0x542a, xboxone_rumblebegin_init, sizeof(xboxone_rumblebegin_init) },

{ 0x24c6, 0x543a, xboxone_rumblebegin_init, sizeof(xboxone_rumblebegin_init) },

{ 0x24c6, 0x541a, xboxone_rumbleend_init, sizeof(xboxone_rumbleend_init) },

{ 0x24c6, 0x542a, xboxone_rumbleend_init, sizeof(xboxone_rumbleend_init) },

{ 0x24c6, 0x543a, xboxone_rumbleend_init, sizeof(xboxone_rumbleend_init) },

};

typedef struct {

Uint8 sequence;

Uint8 last_state[USB_PACKET_LENGTH];

Uint32 rumble_expiration;

} SDL_DriverXboxOne_Context;

static SDL_bool

HIDAPI_DriverXboxOne_IsSupportedDevice(Uint16 vendor_id, Uint16 product_id, int interface_number, Uint16 usage_page, Uint16 usage)

{

return SDL_IsJoystickXboxOne(vendor_id, product_id);

}

static const char *

HIDAPI_DriverXboxOne_GetDeviceName(Uint16 vendor_id, Uint16 product_id)

{

int i;

for (i = 0; i < SDL_arraysize(xboxone_devicenames); ++i) {

const SDL_DriverXboxOne_DeviceName *entry = &xboxone_devicenames[i];

if (vendor_id == entry->vendor_id && product_id == entry->product_id) {

return entry->name;

}

}

return NULL;

}

static SDL_bool

HIDAPI_DriverXboxOne_Init(SDL_Joystick *joystick, hid_device *dev, Uint16 vendor_id, Uint16 product_id, void **context)

{

SDL_DriverXboxOne_Context *ctx;

int i;

Uint8 init_packet[USB_PACKET_LENGTH];

ctx = (SDL_DriverXboxOne_Context *)SDL_calloc(1, sizeof(*ctx));

if (!ctx) {

SDL_OutOfMemory();

return SDL_FALSE;

}

*context = ctx;

/* Send the controller init data */

for (i = 0; i < SDL_arraysize(xboxone_init_packets); ++i) {

const SDL_DriverXboxOne_InitPacket *packet = &xboxone_init_packets[i];

if (!packet->vendor_id || (vendor_id == packet->vendor_id && product_id == packet->product_id)) {

SDL_memcpy(init_packet, packet->data, packet->size);

init_packet[2] = ctx->sequence++;

if (hid_write(dev, init_packet, packet->size) != packet->size) {

SDL_SetError("Couldn't write Xbox One initialization packet");

SDL_free(ctx);

return SDL_FALSE;

}

}

}

/* Initialize the joystick capabilities */

joystick->nbuttons = SDL_CONTROLLER_BUTTON_MAX;

joystick->naxes = SDL_CONTROLLER_AXIS_MAX;

joystick->epowerlevel = SDL_JOYSTICK_POWER_WIRED;

return SDL_TRUE;

}

static int

HIDAPI_DriverXboxOne_Rumble(SDL_Joystick *joystick, hid_device *dev, void *context, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms)

{

SDL_DriverXboxOne_Context *ctx = (SDL_DriverXboxOne_Context *)context;

Uint8 rumble_packet[] = { 0x09, 0x00, 0x00, 0x09, 0x00, 0x0F, 0x00, 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF };

/* The Rock Candy Xbox One Controller limits the range of

low frequency rumble strength in the range of [0 - 0x99]

high frequency rumble strength in the range of [0 - 0x82]

I think the valid range of rumble at the firmware level is [0 - 0x7F]

*/

rumble_packet[2] = ctx->sequence++;

rumble_packet[8] = (low_frequency_rumble >> 9);

rumble_packet[9] = (high_frequency_rumble >> 9);

if (hid_write(dev, rumble_packet, sizeof(rumble_packet)) != sizeof(rumble_packet)) {

return SDL_SetError("Couldn't send rumble packet");

}

if ((low_frequency_rumble || high_frequency_rumble) && duration_ms) {

ctx->rumble_expiration = SDL_GetTicks() + duration_ms;

} else {

ctx->rumble_expiration = 0;

}

return 0;

}

static void

HIDAPI_DriverXboxOne_HandleStatePacket(SDL_Joystick *joystick, hid_device *dev, SDL_DriverXboxOne_Context *ctx, Uint8 *data, int size)

{

Sint16 axis;

if (ctx->last_state[4] != data[4]) {

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_START, (data[4] & 0x04) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_BACK, (data[4] & 0x08) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_A, (data[4] & 0x10) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_B, (data[4] & 0x20) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_X, (data[4] & 0x40) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_Y, (data[4] & 0x80) ? SDL_PRESSED : SDL_RELEASED);

}

if (ctx->last_state[5] != data[5]) {

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_UP, (data[5] & 0x01) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_DOWN, (data[5] & 0x02) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_LEFT, (data[5] & 0x04) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_RIGHT, (data[5] & 0x08) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_LEFTSHOULDER, (data[5] & 0x10) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_RIGHTSHOULDER, (data[5] & 0x20) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_LEFTSTICK, (data[5] & 0x40) ? SDL_PRESSED : SDL_RELEASED);

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_RIGHTSTICK, (data[5] & 0x80) ? SDL_PRESSED : SDL_RELEASED);

}

axis = ((int)*(Sint16*)(&data[6]) * 64) - 32768;

SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_TRIGGERLEFT, axis);

axis = ((int)*(Sint16*)(&data[8]) * 64) - 32768;

SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_TRIGGERRIGHT, axis);

axis = *(Sint16*)(&data[10]);

SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_LEFTX, axis);

axis = *(Sint16*)(&data[12]);

SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_LEFTY, ~axis);

axis = *(Sint16*)(&data[14]);

SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_RIGHTX, axis);

axis = *(Sint16*)(&data[16]);

SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_RIGHTY, ~axis);

SDL_memcpy(ctx->last_state, data, SDL_min(size, sizeof(ctx->last_state)));

}

static void

HIDAPI_DriverXboxOne_HandleModePacket(SDL_Joystick *joystick, hid_device *dev, SDL_DriverXboxOne_Context *ctx, Uint8 *data, int size)

{

if (data[1] == 0x30) {

/* The Xbox One S controller needs acks for mode reports */

const Uint8 seqnum = data[2];

const Uint8 ack[] = { 0x01, 0x20, seqnum, 0x09, 0x00, 0x07, 0x20, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00 };

hid_write(dev, ack, sizeof(ack));

}

SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_GUIDE, (data[4] & 0x01) ? SDL_PRESSED : SDL_RELEASED);

}

static void

HIDAPI_DriverXboxOne_Update(SDL_Joystick *joystick, hid_device *dev, void *context)

{

SDL_DriverXboxOne_Context *ctx = (SDL_DriverXboxOne_Context *)context;

Uint8 data[USB_PACKET_LENGTH];

int size;

while ((size = hid_read_timeout(dev, data, sizeof(data), 0)) > 0) {

switch (data[0]) {

case 0x20:

HIDAPI_DriverXboxOne_HandleStatePacket(joystick, dev, ctx, data, size);

break;

case 0x07:

HIDAPI_DriverXboxOne_HandleModePacket(joystick, dev, ctx, data, size);

break;

default:

#ifdef DEBUG_JOYSTICK

SDL_Log("Unknown Xbox One packet: 0x%.2x\n", data[0]);

#endif

break;

}

}

if (ctx->rumble_expiration) {

Uint32 now = SDL_GetTicks();

if (SDL_TICKS_PASSED(now, ctx->rumble_expiration)) {

HIDAPI_DriverXboxOne_Rumble(joystick, dev, context, 0, 0, 0);

}

}

}

static void

HIDAPI_DriverXboxOne_Quit(SDL_Joystick *joystick, hid_device *dev, void *context)

{

SDL_free(context);

}

SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverXboxOne =

{

SDL_HINT_JOYSTICK_HIDAPI_XBOXONE,

SDL_TRUE,

HIDAPI_DriverXboxOne_IsSupportedDevice,

HIDAPI_DriverXboxOne_GetDeviceName,

HIDAPI_DriverXboxOne_Init,

HIDAPI_DriverXboxOne_Rumble,

HIDAPI_DriverXboxOne_Update,

HIDAPI_DriverXboxOne_Quit

};

#endif /* SDL_JOYSTICK_HIDAPI_XBOXONE */

#endif /* SDL_JOYSTICK_HIDAPI */

/* vi: set ts=4 sw=4 expandtab: */