src/joystick/hidapi/SDL_hidapijoystick_c.h
author Sam Lantinga
Mon, 16 Dec 2019 10:20:03 -0800
changeset 13348 448528dc13da
parent 13330 c88765bcf1da
child 13354 8c22865bd138
permissions -rw-r--r--
Fixed bug 4898 - No rumble because of integer overflow in SDL_JoystickRumble

meyraud705

On a Dualshock 4 controller using hidapi driver, calling SDL_JoystickRumble with a duration too long (SDL_HAPTIC_INFINITY for example) causes the rumble to stop immediately.

This happens because of integer overflow on line 301 of SDL_hidapi_ps4.c
(https://hg.libsdl.org/SDL/file/99ecd178999f/src/joystick/hidapi/SDL_hidapi_ps4.c#l301), which sets expiration time in the past.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 #include "../../SDL_internal.h"
    22 
    23 #ifndef SDL_JOYSTICK_HIDAPI_H
    24 #define SDL_JOYSTICK_HIDAPI_H
    25 
    26 #include "../../hidapi/hidapi/hidapi.h"
    27 
    28 /* This is the full set of HIDAPI drivers available */
    29 #define SDL_JOYSTICK_HIDAPI_PS4
    30 #define SDL_JOYSTICK_HIDAPI_SWITCH
    31 #define SDL_JOYSTICK_HIDAPI_XBOX360
    32 #define SDL_JOYSTICK_HIDAPI_XBOXONE
    33 
    34 #ifdef __WINDOWS__
    35 /* On Windows, Xbox One controllers are handled by the Xbox 360 driver */
    36 #undef SDL_JOYSTICK_HIDAPI_XBOXONE
    37 /* It turns out HIDAPI for Xbox controllers doesn't allow background input */
    38 #undef SDL_JOYSTICK_HIDAPI_XBOX360
    39 #endif
    40 
    41 #ifdef __MACOSX__
    42 /* On Mac OS X, Xbox One controllers are handled by the Xbox 360 driver */
    43 #undef SDL_JOYSTICK_HIDAPI_XBOXONE
    44 #endif
    45 
    46 /* Prevent rumble duration overflow */
    47 #define SDL_MAX_RUMBLE_DURATION_MS  0x0fffffff
    48 
    49 typedef struct _SDL_HIDAPI_DeviceDriver
    50 {
    51     const char *hint;
    52     SDL_bool enabled;
    53     SDL_bool (*IsSupportedDevice)(Uint16 vendor_id, Uint16 product_id, Uint16 version, int interface_number, const char *name);
    54     const char *(*GetDeviceName)(Uint16 vendor_id, Uint16 product_id);
    55     SDL_bool (*Init)(SDL_Joystick *joystick, hid_device *dev, Uint16 vendor_id, Uint16 product_id, void **context);
    56     int (*Rumble)(SDL_Joystick *joystick, hid_device *dev, void *context, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
    57     SDL_bool (*Update)(SDL_Joystick *joystick, hid_device *dev, void *context);
    58     void (*Quit)(SDL_Joystick *joystick, hid_device *dev, void *context);
    59 
    60 } SDL_HIDAPI_DeviceDriver;
    61 
    62 /* HIDAPI device support */
    63 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverPS4;
    64 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverSteam;
    65 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverSwitch;
    66 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverXbox360;
    67 extern SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverXboxOne;
    68 
    69 /* Return true if a HID device is present and supported as a joystick */
    70 extern SDL_bool HIDAPI_IsDevicePresent(Uint16 vendor_id, Uint16 product_id, Uint16 version, const char *name);
    71 
    72 #endif /* SDL_JOYSTICK_HIDAPI_H */
    73 
    74 /* vi: set ts=4 sw=4 expandtab: */