Revamped Xbox One HIDAPI init sequence Added support for querying the controller serial number on newer firmware
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
diff --git a/src/hidapi/SDL_hidapi.c b/src/hidapi/SDL_hidapi.c
index aa44e69..061b213 100644
--- a/src/hidapi/SDL_hidapi.c
+++ b/src/hidapi/SDL_hidapi.c
@@ -63,6 +63,7 @@
#define make_path PLATFORM_make_path
#define read_thread PLATFORM_read_thread
+#undef HIDAPI_H__
#if __LINUX__
#include "../../core/linux/SDL_udev.h"
@@ -130,7 +131,7 @@ static const SDL_UDEV_Symbols *udev_ctx = NULL;
#undef read_thread
#ifdef HAVE_HIDAPI_NVAGIPMAN
-#define HAVE_DRIVER_BACKEND
+#define HAVE_DRIVER_BACKEND 1
#endif
#ifdef HAVE_DRIVER_BACKEND
@@ -160,6 +161,7 @@ static const SDL_UDEV_Symbols *udev_ctx = NULL;
#define hid_error DRIVER_hid_error
#ifdef HAVE_HIDAPI_NVAGIPMAN
+#undef HIDAPI_H__
#include "nvagipman/hid.c"
#else
#error Need a driver hid.c for this platform!
@@ -496,6 +498,28 @@ LIBUSB_CopyHIDDeviceInfo(struct LIBUSB_hid_device_info *pSrc,
}
#endif /* SDL_LIBUSB_DYNAMIC */
+#if HAVE_DRIVER_BACKEND
+static void
+DRIVER_CopyHIDDeviceInfo(struct DRIVER_hid_device_info *pSrc,
+ struct hid_device_info *pDst)
+{
+ COPY_IF_EXISTS(path)
+ pDst->vendor_id = pSrc->vendor_id;
+ pDst->product_id = pSrc->product_id;
+ WCOPY_IF_EXISTS(serial_number)
+ pDst->release_number = pSrc->release_number;
+ WCOPY_IF_EXISTS(manufacturer_string)
+ WCOPY_IF_EXISTS(product_string)
+ pDst->usage_page = pSrc->usage_page;
+ pDst->usage = pSrc->usage;
+ pDst->interface_number = pSrc->interface_number;
+ pDst->interface_class = pSrc->interface_class;
+ pDst->interface_subclass = pSrc->interface_subclass;
+ pDst->interface_protocol = pSrc->interface_protocol;
+ pDst->next = NULL;
+}
+#endif /* HAVE_DRIVER_BACKEND */
+
#if HAVE_PLATFORM_BACKEND
static void
PLATFORM_CopyHIDDeviceInfo(struct PLATFORM_hid_device_info *pSrc,
@@ -647,6 +671,21 @@ struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned shor
}
#endif /* SDL_LIBUSB_DYNAMIC */
+#ifdef HAVE_DRIVER_BACKEND
+ driver_devs = DRIVER_hid_enumerate(vendor_id, product_id);
+ for (driver_dev = driver_devs; driver_dev; driver_dev = driver_dev->next) {
+ new_dev = (struct hid_device_info*) SDL_malloc(sizeof(struct hid_device_info));
+ DRIVER_CopyHIDDeviceInfo(driver_dev, new_dev);
+
+ if (last != NULL) {
+ last->next = new_dev;
+ } else {
+ devs = new_dev;
+ }
+ last = new_dev;
+ }
+#endif /* HAVE_DRIVER_BACKEND */
+
#if HAVE_PLATFORM_BACKEND
if (udev_ctx) {
raw_devs = PLATFORM_hid_enumerate(vendor_id, product_id);
@@ -662,6 +701,16 @@ struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned shor
}
}
#endif
+#ifdef HAVE_DRIVER_BACKEND
+ for (driver_dev = driver_devs; driver_dev; driver_dev = driver_dev->next) {
+ if (raw_dev->vendor_id == driver_dev->vendor_id &&
+ raw_dev->product_id == driver_dev->product_id &&
+ (raw_dev->interface_number < 0 || raw_dev->interface_number == driver_dev->interface_number)) {
+ bFound = SDL_TRUE;
+ break;
+ }
+ }
+#endif
if (!bFound) {
new_dev = (struct hid_device_info*) SDL_malloc(sizeof(struct hid_device_info));
PLATFORM_CopyHIDDeviceInfo(raw_dev, new_dev);
@@ -755,8 +804,7 @@ HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path, int bEx
#endif /* HAVE_PLATFORM_BACKEND */
#if HAVE_DRIVER_BACKEND
- if (udev_ctx &&
- (pDevice = (hid_device*) DRIVER_hid_open_path(path, bExclusive)) != NULL) {
+ if ((pDevice = (hid_device*) DRIVER_hid_open_path(path, bExclusive)) != NULL) {
HIDDeviceWrapper *wrapper = CreateHIDDeviceWrapper(pDevice, &DRIVER_Backend);
return WrapHIDDevice(wrapper);
diff --git a/src/joystick/SDL_joystick.c b/src/joystick/SDL_joystick.c
index d03c7a4..01cf7f4 100644
--- a/src/joystick/SDL_joystick.c
+++ b/src/joystick/SDL_joystick.c
@@ -1729,6 +1729,12 @@ SDL_CreateJoystickName(Uint16 vendor, Uint16 product, const char *vendor_name, c
}
SDL_GameControllerType
+SDL_GetJoystickGameControllerTypeFromVIDPID(Uint16 vendor, Uint16 product)
+{
+ return SDL_GetJoystickGameControllerType(NULL, vendor, product, -1, 0, 0, 0);
+}
+
+SDL_GameControllerType
SDL_GetJoystickGameControllerTypeFromGUID(SDL_JoystickGUID guid, const char *name)
{
SDL_GameControllerType type;
diff --git a/src/joystick/SDL_joystick_c.h b/src/joystick/SDL_joystick_c.h
index 2cceb34..de330ab 100644
--- a/src/joystick/SDL_joystick_c.h
+++ b/src/joystick/SDL_joystick_c.h
@@ -58,6 +58,7 @@ extern void SDL_GetJoystickGUIDInfo(SDL_JoystickGUID guid, Uint16 *vendor, Uint1
extern char *SDL_CreateJoystickName(Uint16 vendor, Uint16 product, const char *vendor_name, const char *product_name);
/* Function to return the type of a controller */
+extern SDL_GameControllerType SDL_GetJoystickGameControllerTypeFromVIDPID(Uint16 vendor, Uint16 product);
extern SDL_GameControllerType SDL_GetJoystickGameControllerTypeFromGUID(SDL_JoystickGUID guid, const char *name);
extern SDL_GameControllerType SDL_GetJoystickGameControllerType(const char *name, Uint16 vendor, Uint16 product, int interface_number, int interface_class, int interface_subclass, int interface_protocol);
diff --git a/src/joystick/hidapi/SDL_hidapi_xbox360.c b/src/joystick/hidapi/SDL_hidapi_xbox360.c
index 5da6cd4..e3b3919 100644
--- a/src/joystick/hidapi/SDL_hidapi_xbox360.c
+++ b/src/joystick/hidapi/SDL_hidapi_xbox360.c
@@ -34,6 +34,10 @@
#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;
@@ -77,6 +81,7 @@ HIDAPI_DriverXbox360_IsSupportedDevice(const char *name, SDL_GameControllerType
/* 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:
@@ -87,7 +92,6 @@ HIDAPI_DriverXbox360_IsSupportedDevice(const char *name, SDL_GameControllerType
if (IsBluetoothXboxOneController(vendor_id, product_id)) {
return SDL_FALSE;
}
-#endif
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;
@@ -126,6 +130,9 @@ HIDAPI_DriverXbox360_GetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_Joystic
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));
}
@@ -296,7 +303,12 @@ HIDAPI_DriverXbox360_UpdateDevice(SDL_HIDAPI_Device *device)
}
while ((size = hid_read_timeout(device->dev, data, sizeof(data), 0)) > 0) {
- HIDAPI_DriverXbox360_HandleStatePacket(joystick, ctx, data, size);
+#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) {
diff --git a/src/joystick/hidapi/SDL_hidapi_xbox360w.c b/src/joystick/hidapi/SDL_hidapi_xbox360w.c
index 2a25134..40dcae6 100644
--- a/src/joystick/hidapi/SDL_hidapi_xbox360w.c
+++ b/src/joystick/hidapi/SDL_hidapi_xbox360w.c
@@ -34,6 +34,9 @@
#ifdef SDL_JOYSTICK_HIDAPI_XBOX360
+/* Define this if you want to log all packets from the controller */
+/*#define DEBUG_XBOX_PROTOCOL*/
+
typedef struct {
SDL_bool connected;
@@ -125,6 +128,9 @@ HIDAPI_DriverXbox360W_GetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_Joysti
static void
HIDAPI_DriverXbox360W_SetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_JoystickID instance_id, int player_index)
{
+ if (!device->dev) {
+ return;
+ }
SetSlotLED(device->dev, (player_index % 4));
}
@@ -244,6 +250,9 @@ HIDAPI_DriverXbox360W_UpdateDevice(SDL_HIDAPI_Device *device)
}
while ((size = hid_read_timeout(device->dev, data, sizeof(data), 0)) > 0) {
+#ifdef DEBUG_XBOX_PROTOCOL
+ HIDAPI_DumpPacket("Xbox 360 wireless packet: size = %d", data, size);
+#endif
if (size == 2 && data[0] == 0x08) {
SDL_bool connected = (data[1] & 0x80) ? SDL_TRUE : SDL_FALSE;
#ifdef DEBUG_JOYSTICK
diff --git a/src/joystick/hidapi/SDL_hidapi_xboxone.c b/src/joystick/hidapi/SDL_hidapi_xboxone.c
index 4fd3665..ac920e2 100644
--- a/src/joystick/hidapi/SDL_hidapi_xboxone.c
+++ b/src/joystick/hidapi/SDL_hidapi_xboxone.c
@@ -34,14 +34,16 @@
#ifdef SDL_JOYSTICK_HIDAPI_XBOXONE
+/* Define this if you want verbose logging of the init sequence */
+/*#define DEBUG_JOYSTICK*/
+
/* Define this if you want to log all packets from the controller */
/*#define DEBUG_XBOX_PROTOCOL*/
-/* The amount of time to wait after hotplug to send controller init sequence */
-#define CONTROLLER_INIT_DELAY_MS 1500 /* 475 for Xbox One S, 1275 for the PDP Battlefield 1 */
+#define CONTROLLER_ANNOUNCE_TIMEOUT_MS 100
+#define CONTROLLER_NEGOTIATION_TIMEOUT_MS 30
+#define CONTROLLER_SERIAL_TIMEOUT_MS 100
-/* The amount of time to wait after init for valid input */
-#define CONTROLLER_INPUT_DELAY_MS 50 /* 42 for Razer Wolverine Ultimate */
/* Connect controller */
static const Uint8 xboxone_init0[] = {
@@ -71,13 +73,6 @@ static const Uint8 xboxone_init5[] = {
0x00, 0x00, 0xFF, 0x00, 0xEB
};
-#ifdef REQUEST_SERIAL_NUMBER
-/* Request serial number */
-static const Uint8 xboxone_init_serial[] = {
- 0x1E, 0x30, 0x07, 0x01, 0x04
-};
-#endif
-
/*
* This specifies the selection of init packets that a gamepad
* will be sent on init *and* the order in which they will be
@@ -106,28 +101,36 @@ static const SDL_DriverXboxOne_InitPacket xboxone_init_packets[] = {
*/
{ 0x0000, 0x0000, 0x045e, 0x0000, xboxone_init4, sizeof(xboxone_init4), { 0x00, 0x00 } },
{ 0x0000, 0x0000, 0x045e, 0x0000, xboxone_init5, sizeof(xboxone_init5), { 0x00, 0x00 } },
-
-#ifdef REQUEST_SERIAL_NUMBER
- { 0x0000, 0x0000, 0x0000, 0x0000, xboxone_init_serial, sizeof(xboxone_init_serial), { 0x00, 0x00 } },
-#endif
};
typedef enum {
XBOX_ONE_WIRELESS_PROTOCOL_UNKNOWN,
XBOX_ONE_WIRELESS_PROTOCOL_V1,
- XBOX_ONE_WIRELESS_PROTOCOL_V2,
+ XBOX_ONE_WIRELESS_PROTOCOL_V2
} SDL_XboxOneWirelessProtocol;
+typedef enum {
+ XBOX_ONE_INIT_STATE_WAITING_FOR_ANNOUNCE = 0,
+ XBOX_ONE_INIT_STATE_RECEIVED_ANNOUNCE = 1,
+ XBOX_ONE_INIT_STATE_START_NEGOTIATING = 2,
+ XBOX_ONE_INIT_STATE_NEGOTIATING = 3,
+ XBOX_ONE_INIT_STATE_READY = 4,
+ XBOX_ONE_INIT_STATE_WAITING_FOR_SERIAL = 5,
+ XBOX_ONE_INIT_STATE_RECEIVED_SERIAL = 6,
+ XBOX_ONE_INIT_STATE_COMPLETE = 7
+} SDL_XboxOneInitState;
+
typedef struct {
Uint16 vendor_id;
Uint16 product_id;
SDL_bool bluetooth;
SDL_XboxOneWirelessProtocol wireless_protocol;
- SDL_bool initialized;
+ SDL_XboxOneInitState init_state;
+ int init_packet;
SDL_bool input_ready;
Uint32 start_time;
- Uint32 initialized_time;
Uint8 sequence;
+ Uint32 send_time;
Uint8 last_state[USB_PACKET_LENGTH];
SDL_bool has_paddles;
SDL_bool has_trigger_rumble;
@@ -171,30 +174,21 @@ ControllerHasShareButton(Uint16 vendor_id, Uint16 product_id)
return SDL_IsJoystickXboxOneSeriesX(vendor_id, product_id);
}
-/* Return true if this controller sends the 0x02 "waiting for init" packet */
-static SDL_bool
-ControllerSendsWaitingForInit(Uint16 vendor_id, Uint16 product_id)
+static void
+SetInitState(SDL_DriverXboxOne_Context *ctx, SDL_XboxOneInitState state)
{
- if (vendor_id == USB_VENDOR_HYPERKIN) {
- /* The Hyperkin controllers always send 0x02 when waiting for init,
- and the Hyperkin Duke plays an Xbox startup animation, so we want
- to make sure we don't send the init sequence if it isn't needed.
- */
- return SDL_TRUE;
- }
- if (vendor_id == USB_VENDOR_PDP) {
- /* The PDP Rock Candy (PID 0x0246) doesn't send 0x02 on Linux for some reason */
- return SDL_FALSE;
- }
-
- /* It doesn't hurt to reinit, especially if a driver has misconfigured the controller */
- /*return SDL_TRUE;*/
- return SDL_FALSE;
+#ifdef DEBUG_JOYSTICK
+ SDL_Log("Setting init state %d\n", state);
+#endif
+ ctx->init_state = state;
}
static void
SendAckIfNeeded(SDL_HIDAPI_Device *device, Uint8 *data, int size)
{
+#ifdef __WIN32__
+ /* The Windows driver is taking care of acks */
+#else
if ((data[1] & 0x30) == 0x30) {
Uint8 ack_packet[] = { 0x01, 0x20, data[2], 0x09, 0x00, data[0], 0x20, data[3], 0x00, 0x00, 0x00, 0x00, 0x00 };
@@ -208,6 +202,23 @@ SendAckIfNeeded(SDL_HIDAPI_Device *device, Uint8 *data, int size)
#endif
hid_write(device->dev, ack_packet, sizeof(ack_packet));
}
+#endif /* __WIN32__ */
+}
+
+static SDL_bool
+SendSerialRequest(SDL_HIDAPI_Device *device, SDL_DriverXboxOne_Context *ctx)
+{
+ Uint8 serial_packet[] = { 0x1E, 0x30, 0x07, 0x01, 0x04 };
+
+ ctx->send_time = SDL_GetTicks();
+
+ /* Request the serial number */
+ if (SDL_HIDAPI_LockRumble() < 0 ||
+ SDL_HIDAPI_SendRumbleAndUnlock(device, serial_packet, sizeof(serial_packet)) != sizeof(serial_packet)) {
+ SDL_SetError("Couldn't send serial packet");
+ return SDL_FALSE;
+ }
+ return SDL_TRUE;
}
static SDL_bool
@@ -215,11 +226,10 @@ SendControllerInit(SDL_HIDAPI_Device *device, SDL_DriverXboxOne_Context *ctx)
{
Uint16 vendor_id = ctx->vendor_id;
Uint16 product_id = ctx->product_id;
- int i;
Uint8 init_packet[USB_PACKET_LENGTH];
- for (i = 0; i < SDL_arraysize(xboxone_init_packets); ++i) {
- const SDL_DriverXboxOne_InitPacket *packet = &xboxone_init_packets[i];
+ for ( ; ctx->init_packet < SDL_arraysize(xboxone_init_packets); ++ctx->init_packet) {
+ const SDL_DriverXboxOne_InitPacket *packet = &xboxone_init_packets[ctx->init_packet];
if (packet->vendor_id && (vendor_id != packet->vendor_id)) {
continue;
@@ -244,35 +254,22 @@ SendControllerInit(SDL_HIDAPI_Device *device, SDL_DriverXboxOne_Context *ctx)
#ifdef DEBUG_XBOX_PROTOCOL
HIDAPI_DumpPacket("Xbox One sending INIT packet: size = %d", init_packet, packet->size);
#endif
- if (hid_write(device->dev, init_packet, packet->size) != packet->size) {
+ ctx->send_time = SDL_GetTicks();
+
+ if (SDL_HIDAPI_LockRumble() < 0 ||
+ SDL_HIDAPI_SendRumbleAndUnlock(device, init_packet, packet->size) != packet->size) {
SDL_SetError("Couldn't write Xbox One initialization packet");
return SDL_FALSE;
}
if (packet->response[0]) {
- const Uint32 RESPONSE_TIMEOUT_MS = 100;
- Uint32 start = SDL_GetTicks();
- SDL_bool got_response = SDL_FALSE;
-
- while (!got_response && !SDL_TICKS_PASSED(SDL_GetTicks(), start + RESPONSE_TIMEOUT_MS)) {
- Uint8 data[USB_PACKET_LENGTH];
- int size;
-
- while ((size = hid_read_timeout(device->dev, data, sizeof(data), 0)) > 0) {
-#ifdef DEBUG_XBOX_PROTOCOL
- HIDAPI_DumpPacket("Xbox One INIT packet: size = %d", data, size);
-#endif
- if (size >= 2 && data[0] == packet->response[0] && data[1] == packet->response[1]) {
- got_response = SDL_TRUE;
- }
- SendAckIfNeeded(device, data, size);
- }
- }
-#ifdef DEBUG_XBOX_PROTOCOL
- SDL_Log("Init sequence %d got response after %u ms: %s\n", i, (SDL_GetTicks() - start), got_response ? "TRUE" : "FALSE");
-#endif
+ return SDL_TRUE;
}
}
+
+ /* All done with the negotiation! */
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_READY);
+
return SDL_TRUE;
}
@@ -317,6 +314,9 @@ HIDAPI_DriverXboxOne_SetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_Joystic
{
}
+static SDL_bool HIDAPI_DriverXboxOne_UpdateJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick);
+static void HIDAPI_DriverXboxOne_CloseJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick);
+
static SDL_bool
HIDAPI_DriverXboxOne_OpenJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
{
@@ -339,13 +339,14 @@ HIDAPI_DriverXboxOne_OpenJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joyst
ctx->vendor_id = device->vendor_id;
ctx->product_id = device->product_id;
ctx->bluetooth = IsBluetoothXboxOneController(device->vendor_id, device->product_id);
- ctx->initialized = ctx->bluetooth ? SDL_TRUE : SDL_FALSE;
ctx->start_time = SDL_GetTicks();
- ctx->input_ready = SDL_TRUE;
ctx->sequence = 1;
ctx->has_paddles = ControllerHasPaddles(ctx->vendor_id, ctx->product_id);
ctx->has_trigger_rumble = ControllerHasTriggerRumble(ctx->vendor_id, ctx->product_id);
ctx->has_share_button = ControllerHasShareButton(ctx->vendor_id, ctx->product_id);
+#ifdef DEBUG_JOYSTICK
+ SDL_Log("Controller version: %d (0x%.4x)\n", device->version, device->version);
+#endif
/* Initialize the joystick capabilities */
joystick->nbuttons = 15;
@@ -358,6 +359,32 @@ HIDAPI_DriverXboxOne_OpenJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joyst
joystick->naxes = SDL_CONTROLLER_AXIS_MAX;
joystick->epowerlevel = SDL_JOYSTICK_POWER_WIRED;
+#ifdef __WIN32__
+ ctx->init_state = XBOX_ONE_INIT_STATE_READY;
+#endif
+
+ if (ctx->bluetooth) {
+ ctx->init_state = XBOX_ONE_INIT_STATE_COMPLETE;
+ }
+
+#ifdef DEBUG_JOYSTICK
+ SDL_Log("Controller init state: %d\n", ctx->init_state);
+#endif
+
+ /* Wait for initialization to complete */
+ while (ctx->init_state != XBOX_ONE_INIT_STATE_COMPLETE) {
+ SDL_Delay(1);
+
+ if (!HIDAPI_DriverXboxOne_UpdateJoystick(device, joystick)) {
+ HIDAPI_DriverXboxOne_CloseJoystick(device, joystick);
+ return SDL_FALSE;
+ }
+ }
+ ctx->input_ready = SDL_TRUE;
+
+#ifdef DEBUG_JOYSTICK
+ SDL_Log("Controller initialization took %u ms\n", (SDL_GetTicks() - ctx->start_time));
+#endif
return SDL_TRUE;
}
@@ -833,33 +860,101 @@ HIDAPI_DriverXboxOneBluetooth_HandleGuidePacket(SDL_Joystick *joystick, hid_devi
SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_GUIDE, (data[1] & 0x01) ? SDL_PRESSED : SDL_RELEASED);
}
-static SDL_bool
-HIDAPI_DriverXboxOne_UpdateDevice(SDL_HIDAPI_Device *device)
+static void
+HIDAPI_DriverXboxOne_HandleSerialIDPacket(SDL_Joystick *joystick, SDL_DriverXboxOne_Context *ctx, Uint8 *data, int size)
{
- SDL_DriverXboxOne_Context *ctx = (SDL_DriverXboxOne_Context *)device->context;
- SDL_Joystick *joystick = NULL;
- Uint8 data[USB_PACKET_LENGTH];
- int size;
+ char serial[ 29 ];
+ int i;
- if (device->num_joysticks > 0) {
- joystick = SDL_JoystickFromInstanceID(device->joysticks[0]);
+ for (i = 0; i < 14; ++i) {
+ SDL_uitoa( data[6 + i], &serial[i * 2], 16 );
}
- if (!joystick) {
- return SDL_FALSE;
+ serial[i * 2] = '\0';
+
+ if (!joystick->serial || SDL_strcmp(joystick->serial, serial) != 0) {
+#ifdef DEBUG_JOYSTICK
+ SDL_Log("Setting serial number to %s\n", serial);
+#endif
+ joystick->serial = SDL_strdup(serial);
}
+}
- if (!ctx->initialized &&
- !ControllerSendsWaitingForInit(device->vendor_id, device->product_id)) {
- if (SDL_TICKS_PASSED(SDL_GetTicks(), ctx->start_time + CONTROLLER_INIT_DELAY_MS)) {
+static SDL_bool
+HIDAPI_DriverXboxOne_UpdateInitState(SDL_HIDAPI_Device *device, SDL_DriverXboxOne_Context *ctx)
+{
+ SDL_XboxOneInitState prev_state;
+ do
+ {
+ prev_state = ctx->init_state;
+
+ switch (ctx->init_state) {
+ case XBOX_ONE_INIT_STATE_WAITING_FOR_ANNOUNCE:
+ if (SDL_TICKS_PASSED(SDL_GetTicks(), ctx->start_time + CONTROLLER_ANNOUNCE_TIMEOUT_MS)) {
+ /* We haven't heard anything, let's move on */
+#ifdef DEBUG_JOYSTICK
+ SDL_Log("Waiting for announce timed out after %u ms\n", (SDL_GetTicks() - ctx->start_time));
+#endif
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_START_NEGOTIATING);
+ }
+ break;
+ case XBOX_ONE_INIT_STATE_RECEIVED_ANNOUNCE:
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_START_NEGOTIATING);
+ break;
+ case XBOX_ONE_INIT_STATE_START_NEGOTIATING:
+ ctx->init_packet = 0;
if (!SendControllerInit(device, ctx)) {
- HIDAPI_JoystickDisconnected(device, joystick->instance_id);
return SDL_FALSE;
}
- ctx->initialized = SDL_TRUE;
- ctx->initialized_time = SDL_GetTicks();
- ctx->input_ready = SDL_FALSE;
+ break;
+ case XBOX_ONE_INIT_STATE_NEGOTIATING:
+ if (SDL_TICKS_PASSED(SDL_GetTicks(), ctx->send_time + CONTROLLER_ANNOUNCE_TIMEOUT_MS)) {
+ /* We haven't heard anything, let's move on */
+#ifdef DEBUG_JOYSTICK
+ SDL_Log("Init sequence %d timed out after %u ms\n", ctx->init_packet, (SDL_GetTicks() - ctx->send_time));
+#endif
+ ++ctx->init_packet;
+ if (!SendControllerInit(device, ctx)) {
+ return SDL_FALSE;
+ }
+ }
+ break;
+ case XBOX_ONE_INIT_STATE_READY:
+ if (device->version >= 0x200) {
+ if (!SendSerialRequest(device, ctx)) {
+ return SDL_FALSE;
+ }
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_WAITING_FOR_SERIAL);
+ } else {
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_COMPLETE);
+ }
+ break;
+ case XBOX_ONE_INIT_STATE_WAITING_FOR_SERIAL:
+ if (SDL_TICKS_PASSED(SDL_GetTicks(), ctx->send_time + CONTROLLER_SERIAL_TIMEOUT_MS)) {
+ /* We haven't heard anything, let's move on */
+#ifdef DEBUG_JOYSTICK
+ SDL_Log("Waiting for serial timed out after %u ms\n", (SDL_GetTicks() - ctx->send_time));
+#endif
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_COMPLETE);
+ }
+ break;
+ case XBOX_ONE_INIT_STATE_RECEIVED_SERIAL:
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_COMPLETE);
+ break;
+ case XBOX_ONE_INIT_STATE_COMPLETE:
+ break;
}
- }
+
+ } while (ctx->init_state != prev_state);
+
+ return SDL_TRUE;
+}
+
+static SDL_bool
+HIDAPI_DriverXboxOne_UpdateJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
+{
+ SDL_DriverXboxOne_Context *ctx = (SDL_DriverXboxOne_Context *)device->context;
+ Uint8 data[USB_PACKET_LENGTH];
+ int size;
while ((size = hid_read_timeout(device->dev, data, sizeof(data), 0)) > 0) {
#ifdef DEBUG_XBOX_PROTOCOL
@@ -913,21 +1008,13 @@ HIDAPI_DriverXboxOne_UpdateDevice(SDL_HIDAPI_Device *device)
is firmware version 5.5.2641.0, and product version 0x0505 = 1285
then 8 bytes of unknown data
*/
- if (!ctx->initialized) {
-#ifdef DEBUG_XBOX_PROTOCOL
- SDL_Log("Delay after init: %ums\n", SDL_GetTicks() - ctx->start_time);
-#endif
- if (!SendControllerInit(device, ctx)) {
- HIDAPI_JoystickDisconnected(device, joystick->instance_id);
- return SDL_FALSE;
- }
- ctx->initialized = SDL_TRUE;
- ctx->initialized_time = SDL_GetTicks();
- ctx->input_ready = SDL_FALSE;
- }
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_RECEIVED_ANNOUNCE);
break;
case 0x03:
/* Controller heartbeat */
+ if (ctx->init_state < XBOX_ONE_INIT_STATE_READY) {
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_READY);
+ }
break;
case 0x04:
/* Unknown chatty controller information, sent by both sides */
@@ -948,18 +1035,21 @@ HIDAPI_DriverXboxOne_UpdateDevice(SDL_HIDAPI_Device *device)
The controller sends that in response to this request:
0x1E 0x30 0x07 0x01 0x04
*/
+ if (size == 20 && data[3] == 0x10) {
+ HIDAPI_DriverXboxOne_HandleSerialIDPacket(joystick, ctx, data, size);
+
+ if (ctx->init_state < XBOX_ONE_INIT_STATE_RECEIVED_SERIAL) {
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_RECEIVED_SERIAL);
+ }
+ }
break;
case 0x20:
- if (!ctx->input_ready) {
- if (!SDL_TICKS_PASSED(SDL_GetTicks(), ctx->initialized_time + CONTROLLER_INPUT_DELAY_MS)) {
-#ifdef DEBUG_XBOX_PROTOCOL
- SDL_Log("Spurious input at %ums\n", SDL_GetTicks() - ctx->initialized_time);
-#endif
- break;
- }
- ctx->input_ready = SDL_TRUE;
+ if (ctx->init_state < XBOX_ONE_INIT_STATE_READY) {
+ SetInitState(ctx, XBOX_ONE_INIT_STATE_READY);
+ }
+ if (ctx->input_ready) {
+ HIDAPI_DriverXboxOne_HandleStatePacket(joystick, device->dev, ctx, data, size);
}
- HIDAPI_DriverXboxOne_HandleStatePacket(joystick, device->dev, ctx, data, size);
break;
default:
#ifdef DEBUG_JOYSTICK
@@ -967,10 +1057,25 @@ HIDAPI_DriverXboxOne_UpdateDevice(SDL_HIDAPI_Device *device)
#endif
break;
}
+
SendAckIfNeeded(device, data, size);
+
+ if (ctx->init_state == XBOX_ONE_INIT_STATE_NEGOTIATING) {
+ const SDL_DriverXboxOne_InitPacket *packet = &xboxone_init_packets[ctx->init_packet];
+
+ if (size >= 4 && data[0] == packet->response[0] && data[1] == packet->response[1]) {
+#ifdef DEBUG_JOYSTICK
+ SDL_Log("Init sequence %d got response after %u ms\n", ctx->init_packet, (SDL_GetTicks() - ctx->send_time));
+#endif
+ ++ctx->init_packet;
+ SendControllerInit(device, ctx);
+ }
+ }
}
}
+ HIDAPI_DriverXboxOne_UpdateInitState(device, ctx);
+
if (size < 0) {
/* Read error, device is disconnected */
HIDAPI_JoystickDisconnected(device, joystick->instance_id);
@@ -978,6 +1083,20 @@ HIDAPI_DriverXboxOne_UpdateDevice(SDL_HIDAPI_Device *device)
return (size >= 0);
}
+static SDL_bool
+HIDAPI_DriverXboxOne_UpdateDevice(SDL_HIDAPI_Device *device)
+{
+ SDL_Joystick *joystick = NULL;
+
+ if (device->num_joysticks > 0) {
+ joystick = SDL_JoystickFromInstanceID(device->joysticks[0]);
+ }
+ if (!joystick) {
+ return SDL_FALSE;
+ }
+ return HIDAPI_DriverXboxOne_UpdateJoystick(device, joystick);
+}
+
static void
HIDAPI_DriverXboxOne_CloseJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
{
diff --git a/src/joystick/hidapi/SDL_hidapijoystick.c b/src/joystick/hidapi/SDL_hidapijoystick.c
index a93bd18..a9ad61a 100644
--- a/src/joystick/hidapi/SDL_hidapijoystick.c
+++ b/src/joystick/hidapi/SDL_hidapijoystick.c
@@ -750,6 +750,38 @@ HIDAPI_AddDevice(struct hid_device_info *info)
char *serial_number = HIDAPI_ConvertString(info->serial_number);
device->name = SDL_CreateJoystickName(device->vendor_id, device->product_id, manufacturer_string, product_string);
+ if (SDL_strncmp(device->name, "0x", 2) == 0) {
+ /* Couldn't find a controller name, try to give it one based on device type */
+ const char *name = NULL;
+
+ switch (SDL_GetJoystickGameControllerType(NULL, device->vendor_id, device->product_id, device->interface_number, device->interface_class, device->interface_subclass, device->interface_protocol)) {
+ case SDL_CONTROLLER_TYPE_XBOX360:
+ name = "Xbox 360 Controller";
+ break;
+ case SDL_CONTROLLER_TYPE_XBOXONE:
+ name = "Xbox One Controller";
+ break;
+ case SDL_CONTROLLER_TYPE_PS3:
+ name = "PS3 Controller";
+ break;
+ case SDL_CONTROLLER_TYPE_PS4:
+ name = "PS4 Controller";
+ break;
+ case SDL_CONTROLLER_TYPE_PS5:
+ name = "PS5 Controller";
+ break;
+ case SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO:
+ name = "Nintendo Switch Pro Controller";
+ break;
+ default:
+ break;
+ }
+
+ if (name) {
+ SDL_free(device->name);
+ device->name = SDL_strdup(name);
+ }
+ }
if (manufacturer_string) {
SDL_free(manufacturer_string);
@@ -856,6 +888,28 @@ HIDAPI_UpdateDeviceList(void)
SDL_UnlockJoysticks();
}
+static SDL_bool
+HIDAPI_IsEquivalentToDevice(Uint16 vendor_id, Uint16 product_id, SDL_HIDAPI_Device *device)
+{
+ if (vendor_id == device->vendor_id && product_id == device->product_id) {
+ return SDL_TRUE;
+ }
+
+ if (vendor_id == USB_VENDOR_MICROSOFT) {
+ /* If we're looking for the wireless XBox 360 controller, also look for the dongle */
+ if (product_id == 0x02a1 && device->product_id == 0x0719) {
+ return SDL_TRUE;
+ }
+
+ /* If we're looking for the raw input Xbox One controller, match it against any other Xbox One controller */
+ if (product_id == 0x02ff &&
+ SDL_GetJoystickGameControllerType(device->name, device->vendor_id, device->product_id, device->interface_number, device->interface_class, device->interface_subclass, device->interface_protocol) == SDL_CONTROLLER_TYPE_XBOXONE) {
+ return SDL_TRUE;
+ }
+ }
+ return SDL_FALSE;
+}
+
SDL_bool
HIDAPI_IsDevicePresent(Uint16 vendor_id, Uint16 product_id, Uint16 version, const char *name)
{
@@ -895,18 +949,14 @@ HIDAPI_IsDevicePresent(Uint16 vendor_id, Uint16 product_id, Uint16 version, cons
SDL_LockJoysticks();
device = SDL_HIDAPI_devices;
while (device) {
- if (device->vendor_id == vendor_id && device->product_id == product_id && device->driver) {
+ if (device->driver &&
+ HIDAPI_IsEquivalentToDevice(vendor_id, product_id, device)) {
result = SDL_TRUE;
}
device = device->next;
}
SDL_UnlockJoysticks();
- /* If we're looking for the wireless XBox 360 controller, also look for the dongle */
- if (!result && vendor_id == USB_VENDOR_MICROSOFT && product_id == 0x02a1) {
- return HIDAPI_IsDevicePresent(USB_VENDOR_MICROSOFT, 0x0719, version, name);
- }
-
#ifdef DEBUG_HIDAPI
SDL_Log("HIDAPI_IsDevicePresent() returning %s for 0x%.4x / 0x%.4x\n", result ? "true" : "false", vendor_id, product_id);
#endif
diff --git a/src/joystick/windows/SDL_rawinputjoystick.c b/src/joystick/windows/SDL_rawinputjoystick.c
index 6ec92a3..23b764e 100644
--- a/src/joystick/windows/SDL_rawinputjoystick.c
+++ b/src/joystick/windows/SDL_rawinputjoystick.c
@@ -774,7 +774,6 @@ RAWINPUT_AddDevice(HANDLE hDevice)
device->joystick_id = SDL_GetNextJoystickInstanceID();
-#define DEBUG_RAWINPUT
#ifdef DEBUG_RAWINPUT
SDL_Log("Adding RAWINPUT device '%s' VID 0x%.4x, PID 0x%.4x, version %d, handle 0x%.8x\n", device->name, device->vendor_id, device->product_id, device->version, device->hDevice);
#endif