SDL_hidapi_steam.c 46 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324
  1. /*
  2. Simple DirectMedia Layer
  3. Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
  4. This software is provided 'as-is', without any express or implied
  5. warranty. In no event will the authors be held liable for any damages
  6. arising from the use of this software.
  7. Permission is granted to anyone to use this software for any purpose,
  8. including commercial applications, and to alter it and redistribute it
  9. freely, subject to the following restrictions:
  10. 1. The origin of this software must not be misrepresented; you must not
  11. claim that you wrote the original software. If you use this software
  12. in a product, an acknowledgment in the product documentation would be
  13. appreciated but is not required.
  14. 2. Altered source versions must be plainly marked as such, and must not be
  15. misrepresented as being the original software.
  16. 3. This notice may not be removed or altered from any source distribution.
  17. */
  18. #include "../../SDL_internal.h"
  19. #ifdef SDL_JOYSTICK_HIDAPI
  20. #include "SDL_events.h"
  21. #include "SDL_timer.h"
  22. #include "SDL_joystick.h"
  23. #include "SDL_gamecontroller.h"
  24. #include "../SDL_sysjoystick.h"
  25. #include "SDL_hidapijoystick_c.h"
  26. #ifdef SDL_JOYSTICK_HIDAPI_STEAM
  27. /*****************************************************************************************************/
  28. #include <stdint.h>
  29. typedef enum
  30. {
  31. false,
  32. true
  33. } bool;
  34. typedef uint32_t uint32;
  35. typedef uint64_t uint64;
  36. #include "steam/controller_constants.h"
  37. #include "steam/controller_structs.h"
  38. typedef struct SteamControllerStateInternal_t
  39. {
  40. // Controller Type for this Controller State
  41. uint32 eControllerType;
  42. // If packet num matches that on your prior call, then the controller state hasn't been changed since
  43. // your last call and there is no need to process it
  44. uint32 unPacketNum;
  45. // bit flags for each of the buttons
  46. uint64 ulButtons;
  47. // Left pad coordinates
  48. short sLeftPadX;
  49. short sLeftPadY;
  50. // Right pad coordinates
  51. short sRightPadX;
  52. short sRightPadY;
  53. // Center pad coordinates
  54. short sCenterPadX;
  55. short sCenterPadY;
  56. // Left analog stick coordinates
  57. short sLeftStickX;
  58. short sLeftStickY;
  59. // Right analog stick coordinates
  60. short sRightStickX;
  61. short sRightStickY;
  62. unsigned short sTriggerL;
  63. unsigned short sTriggerR;
  64. short sAccelX;
  65. short sAccelY;
  66. short sAccelZ;
  67. short sGyroX;
  68. short sGyroY;
  69. short sGyroZ;
  70. float sGyroQuatW;
  71. float sGyroQuatX;
  72. float sGyroQuatY;
  73. float sGyroQuatZ;
  74. short sGyroSteeringAngle;
  75. unsigned short sBatteryLevel;
  76. // Pressure sensor data.
  77. unsigned short sPressurePadLeft;
  78. unsigned short sPressurePadRight;
  79. unsigned short sPressureBumperLeft;
  80. unsigned short sPressureBumperRight;
  81. // Internal state data
  82. short sPrevLeftPad[2];
  83. short sPrevLeftStick[2];
  84. } SteamControllerStateInternal_t;
  85. /* Defines for ulButtons in SteamControllerStateInternal_t */
  86. #define STEAM_RIGHT_TRIGGER_MASK 0x00000001
  87. #define STEAM_LEFT_TRIGGER_MASK 0x00000002
  88. #define STEAM_RIGHT_BUMPER_MASK 0x00000004
  89. #define STEAM_LEFT_BUMPER_MASK 0x00000008
  90. #define STEAM_BUTTON_0_MASK 0x00000010 /* Y */
  91. #define STEAM_BUTTON_1_MASK 0x00000020 /* B */
  92. #define STEAM_BUTTON_2_MASK 0x00000040 /* X */
  93. #define STEAM_BUTTON_3_MASK 0x00000080 /* A */
  94. #define STEAM_TOUCH_0_MASK 0x00000100 /* DPAD UP */
  95. #define STEAM_TOUCH_1_MASK 0x00000200 /* DPAD RIGHT */
  96. #define STEAM_TOUCH_2_MASK 0x00000400 /* DPAD LEFT */
  97. #define STEAM_TOUCH_3_MASK 0x00000800 /* DPAD DOWN */
  98. #define STEAM_BUTTON_MENU_MASK 0x00001000 /* SELECT */
  99. #define STEAM_BUTTON_STEAM_MASK 0x00002000 /* GUIDE */
  100. #define STEAM_BUTTON_ESCAPE_MASK 0x00004000 /* START */
  101. #define STEAM_BUTTON_BACK_LEFT_MASK 0x00008000
  102. #define STEAM_BUTTON_BACK_RIGHT_MASK 0x00010000
  103. #define STEAM_BUTTON_LEFTPAD_CLICKED_MASK 0x00020000
  104. #define STEAM_BUTTON_RIGHTPAD_CLICKED_MASK 0x00040000
  105. #define STEAM_LEFTPAD_FINGERDOWN_MASK 0x00080000
  106. #define STEAM_RIGHTPAD_FINGERDOWN_MASK 0x00100000
  107. #define STEAM_JOYSTICK_BUTTON_MASK 0x00400000
  108. #define STEAM_LEFTPAD_AND_JOYSTICK_MASK 0x00800000
  109. // Look for report version 0x0001, type WIRELESS (3), length >= 1 byte
  110. #define D0G_IS_VALID_WIRELESS_EVENT(data, len) ((len) >= 5 && (data)[0] == 1 && (data)[1] == 0 && (data)[2] == 3 && (data)[3] >= 1)
  111. #define D0G_GET_WIRELESS_EVENT_TYPE(data) ((data)[4])
  112. #define D0G_WIRELESS_DISCONNECTED 1
  113. #define D0G_WIRELESS_ESTABLISHED 2
  114. #define D0G_WIRELESS_NEWLYPAIRED 3
  115. #define D0G_IS_WIRELESS_DISCONNECT(data, len) ( D0G_IS_VALID_WIRELESS_EVENT(data,len) && D0G_GET_WIRELESS_EVENT_TYPE(data) == D0G_WIRELESS_DISCONNECTED )
  116. #define MAX_REPORT_SEGMENT_PAYLOAD_SIZE 18
  117. /*
  118. * SteamControllerPacketAssembler has to be used when reading output repots from controllers.
  119. */
  120. typedef struct
  121. {
  122. uint8_t uBuffer[ MAX_REPORT_SEGMENT_PAYLOAD_SIZE * 8 + 1 ];
  123. int nExpectedSegmentNumber;
  124. bool bIsBle;
  125. } SteamControllerPacketAssembler;
  126. #undef clamp
  127. #define clamp(val, min, max) (((val) > (max)) ? (max) : (((val) < (min)) ? (min) : (val)))
  128. #undef offsetof
  129. #define offsetof(s,m) (size_t)&(((s *)0)->m)
  130. #ifdef DEBUG_STEAM_CONTROLLER
  131. #define DPRINTF(format, ...) printf(format, ##__VA_ARGS__)
  132. #define HEXDUMP(ptr, len) hexdump(ptr, len)
  133. #else
  134. #define DPRINTF(format, ...)
  135. #define HEXDUMP(ptr, len)
  136. #endif
  137. #define printf SDL_Log
  138. #define MAX_REPORT_SEGMENT_SIZE ( MAX_REPORT_SEGMENT_PAYLOAD_SIZE + 2 )
  139. #define CALC_REPORT_SEGMENT_NUM(index) ( ( index / MAX_REPORT_SEGMENT_PAYLOAD_SIZE ) & 0x07 )
  140. #define REPORT_SEGMENT_DATA_FLAG 0x80
  141. #define REPORT_SEGMENT_LAST_FLAG 0x40
  142. #define BLE_REPORT_NUMBER 0x03
  143. #define STEAMCONTROLLER_TRIGGER_MAX_ANALOG 26000
  144. // Enable mouse mode when using the Steam Controller locally
  145. #undef ENABLE_MOUSE_MODE
  146. // Wireless firmware quirk: the firmware intentionally signals "failure" when performing
  147. // SET_FEATURE / GET_FEATURE when it actually means "pending radio roundtrip". The only
  148. // way to make SET_FEATURE / GET_FEATURE work is to loop several times with a sleep. If
  149. // it takes more than 50ms to get the response for SET_FEATURE / GET_FEATURE, we assume
  150. // that the controller has failed.
  151. #define RADIO_WORKAROUND_SLEEP_ATTEMPTS 50
  152. #define RADIO_WORKAROUND_SLEEP_DURATION_US 500
  153. // This was defined by experimentation. 2000 seemed to work but to give that extra bit of margin, set to 3ms.
  154. #define CONTROLLER_CONFIGURATION_DELAY_US 3000
  155. static uint8_t GetSegmentHeader( int nSegmentNumber, bool bLastPacket )
  156. {
  157. uint8_t header = REPORT_SEGMENT_DATA_FLAG;
  158. header |= nSegmentNumber;
  159. if ( bLastPacket )
  160. header |= REPORT_SEGMENT_LAST_FLAG;
  161. return header;
  162. }
  163. static void hexdump( const uint8_t *ptr, int len )
  164. {
  165. int i;
  166. for ( i = 0; i < len ; ++i )
  167. printf("%02x ", ptr[i]);
  168. printf("\n");
  169. }
  170. static void ResetSteamControllerPacketAssembler( SteamControllerPacketAssembler *pAssembler )
  171. {
  172. SDL_memset( pAssembler->uBuffer, 0, sizeof( pAssembler->uBuffer ) );
  173. pAssembler->nExpectedSegmentNumber = 0;
  174. }
  175. static void InitializeSteamControllerPacketAssembler( SteamControllerPacketAssembler *pAssembler )
  176. {
  177. /* We only support BLE devices right now */
  178. pAssembler->bIsBle = true;
  179. ResetSteamControllerPacketAssembler( pAssembler );
  180. }
  181. // Returns:
  182. // <0 on error
  183. // 0 on not ready
  184. // Complete packet size on completion
  185. static int WriteSegmentToSteamControllerPacketAssembler( SteamControllerPacketAssembler *pAssembler, const uint8_t *pSegment, int nSegmentLength )
  186. {
  187. if ( pAssembler->bIsBle )
  188. {
  189. uint8_t uSegmentHeader = pSegment[ 1 ];
  190. int nSegmentNumber = uSegmentHeader & 0x07;
  191. HEXDUMP( pSegment, nSegmentLength );
  192. if ( pSegment[ 0 ] != BLE_REPORT_NUMBER )
  193. {
  194. // We may get keyboard/mouse input events until controller stops sending them
  195. return 0;
  196. }
  197. if ( nSegmentLength != MAX_REPORT_SEGMENT_SIZE )
  198. {
  199. printf( "Bad segment size! %d\n", (int)nSegmentLength );
  200. hexdump( pSegment, nSegmentLength );
  201. ResetSteamControllerPacketAssembler( pAssembler );
  202. return -1;
  203. }
  204. DPRINTF("GOT PACKET HEADER = 0x%x\n", uSegmentHeader);
  205. if ( ( uSegmentHeader & REPORT_SEGMENT_DATA_FLAG ) == 0 )
  206. {
  207. // We get empty segments, just ignore them
  208. return 0;
  209. }
  210. if ( nSegmentNumber != pAssembler->nExpectedSegmentNumber )
  211. {
  212. ResetSteamControllerPacketAssembler( pAssembler );
  213. if ( nSegmentNumber )
  214. {
  215. // This happens occasionally
  216. DPRINTF("Bad segment number, got %d, expected %d\n",
  217. nSegmentNumber, pAssembler->nExpectedSegmentNumber );
  218. return -1;
  219. }
  220. }
  221. SDL_memcpy( pAssembler->uBuffer + nSegmentNumber * MAX_REPORT_SEGMENT_PAYLOAD_SIZE,
  222. pSegment + 2, // ignore header and report number
  223. MAX_REPORT_SEGMENT_PAYLOAD_SIZE );
  224. if ( uSegmentHeader & REPORT_SEGMENT_LAST_FLAG )
  225. {
  226. pAssembler->nExpectedSegmentNumber = 0;
  227. return ( nSegmentNumber + 1 ) * MAX_REPORT_SEGMENT_PAYLOAD_SIZE;
  228. }
  229. pAssembler->nExpectedSegmentNumber++;
  230. }
  231. else
  232. {
  233. // Just pass through
  234. SDL_memcpy( pAssembler->uBuffer,
  235. pSegment,
  236. nSegmentLength );
  237. return nSegmentLength;
  238. }
  239. return 0;
  240. }
  241. #define BLE_MAX_READ_RETRIES 8
  242. static int SetFeatureReport( SDL_hid_device *dev, unsigned char uBuffer[65], int nActualDataLen )
  243. {
  244. int nRet = -1;
  245. bool bBle = true; // only wireless/BLE for now, though macOS could do wired in the future
  246. DPRINTF("SetFeatureReport %p %p %d\n", dev, uBuffer, nActualDataLen);
  247. if ( bBle )
  248. {
  249. int nSegmentNumber = 0;
  250. uint8_t uPacketBuffer[ MAX_REPORT_SEGMENT_SIZE ];
  251. unsigned char *pBufferPtr = uBuffer + 1;
  252. if ( nActualDataLen < 1 )
  253. return -1;
  254. // Skip report number in data
  255. nActualDataLen--;
  256. while ( nActualDataLen > 0 )
  257. {
  258. int nBytesInPacket = nActualDataLen > MAX_REPORT_SEGMENT_PAYLOAD_SIZE ? MAX_REPORT_SEGMENT_PAYLOAD_SIZE : nActualDataLen;
  259. nActualDataLen -= nBytesInPacket;
  260. // Construct packet
  261. SDL_memset( uPacketBuffer, 0, sizeof( uPacketBuffer ) );
  262. uPacketBuffer[ 0 ] = BLE_REPORT_NUMBER;
  263. uPacketBuffer[ 1 ] = GetSegmentHeader( nSegmentNumber, nActualDataLen == 0 );
  264. SDL_memcpy( &uPacketBuffer[ 2 ], pBufferPtr, nBytesInPacket );
  265. pBufferPtr += nBytesInPacket;
  266. nSegmentNumber++;
  267. nRet = SDL_hid_send_feature_report( dev, uPacketBuffer, sizeof( uPacketBuffer ) );
  268. DPRINTF("SetFeatureReport() ret = %d\n", nRet);
  269. }
  270. }
  271. return nRet;
  272. }
  273. static int GetFeatureReport( SDL_hid_device *dev, unsigned char uBuffer[65] )
  274. {
  275. int nRet = -1;
  276. bool bBle = true;
  277. DPRINTF("GetFeatureReport( %p %p )\n", dev, uBuffer );
  278. if ( bBle )
  279. {
  280. int nRetries = 0;
  281. uint8_t uSegmentBuffer[ MAX_REPORT_SEGMENT_SIZE + 1 ];
  282. uint8_t ucBytesToRead = MAX_REPORT_SEGMENT_SIZE;
  283. uint8_t ucDataStartOffset = 0;
  284. SteamControllerPacketAssembler assembler;
  285. InitializeSteamControllerPacketAssembler( &assembler );
  286. // On Windows and macOS, BLE devices get 2 copies of the feature report ID, one that is removed by ReadFeatureReport,
  287. // and one that's included in the buffer we receive. We pad the bytes to read and skip over the report ID
  288. // if necessary.
  289. #if defined(__WIN32__) || defined(__MACOS__)
  290. ++ucBytesToRead;
  291. ++ucDataStartOffset;
  292. #endif
  293. while( nRetries < BLE_MAX_READ_RETRIES )
  294. {
  295. SDL_memset( uSegmentBuffer, 0, sizeof( uSegmentBuffer ) );
  296. uSegmentBuffer[ 0 ] = BLE_REPORT_NUMBER;
  297. nRet = SDL_hid_get_feature_report( dev, uSegmentBuffer, ucBytesToRead );
  298. DPRINTF( "GetFeatureReport ble ret=%d\n", nRet );
  299. HEXDUMP( uSegmentBuffer, nRet );
  300. // Zero retry counter if we got data
  301. if ( nRet > 2 && ( uSegmentBuffer[ ucDataStartOffset + 1 ] & REPORT_SEGMENT_DATA_FLAG ) )
  302. nRetries = 0;
  303. else
  304. nRetries++;
  305. if ( nRet > 0 )
  306. {
  307. int nPacketLength = WriteSegmentToSteamControllerPacketAssembler( &assembler,
  308. uSegmentBuffer + ucDataStartOffset,
  309. nRet - ucDataStartOffset );
  310. if ( nPacketLength > 0 && nPacketLength < 65 )
  311. {
  312. // Leave space for "report number"
  313. uBuffer[ 0 ] = 0;
  314. SDL_memcpy( uBuffer + 1, assembler.uBuffer, nPacketLength );
  315. return nPacketLength;
  316. }
  317. }
  318. }
  319. printf("Could not get a full ble packet after %d retries\n", nRetries );
  320. return -1;
  321. }
  322. return nRet;
  323. }
  324. static int ReadResponse( SDL_hid_device *dev, uint8_t uBuffer[65], int nExpectedResponse )
  325. {
  326. int nRet = GetFeatureReport( dev, uBuffer );
  327. DPRINTF("ReadResponse( %p %p %d )\n", dev, uBuffer, nExpectedResponse );
  328. if ( nRet < 0 )
  329. return nRet;
  330. DPRINTF("ReadResponse got %d bytes of data: ", nRet );
  331. HEXDUMP( uBuffer, nRet );
  332. if ( uBuffer[1] != nExpectedResponse )
  333. return -1;
  334. return nRet;
  335. }
  336. //---------------------------------------------------------------------------
  337. // Reset steam controller (unmap buttons and pads) and re-fetch capability bits
  338. //---------------------------------------------------------------------------
  339. static bool ResetSteamController( SDL_hid_device *dev, bool bSuppressErrorSpew, uint32_t *punUpdateRateUS )
  340. {
  341. // Firmware quirk: Set Feature and Get Feature requests always require a 65-byte buffer.
  342. unsigned char buf[65];
  343. unsigned int i;
  344. int res = -1;
  345. int nSettings = 0;
  346. int nAttributesLength;
  347. FeatureReportMsg *msg;
  348. uint32_t unUpdateRateUS = 9000; // Good default rate
  349. DPRINTF( "ResetSteamController hid=%p\n", dev );
  350. buf[0] = 0;
  351. buf[1] = ID_GET_ATTRIBUTES_VALUES;
  352. res = SetFeatureReport( dev, buf, 2 );
  353. if ( res < 0 )
  354. {
  355. if ( !bSuppressErrorSpew )
  356. printf( "GET_ATTRIBUTES_VALUES failed for controller %p\n", dev );
  357. return false;
  358. }
  359. // Retrieve GET_ATTRIBUTES_VALUES result
  360. // Wireless controller endpoints without a connected controller will return nAttrs == 0
  361. res = ReadResponse( dev, buf, ID_GET_ATTRIBUTES_VALUES );
  362. if ( res < 0 || buf[1] != ID_GET_ATTRIBUTES_VALUES )
  363. {
  364. HEXDUMP(buf, res);
  365. if ( !bSuppressErrorSpew )
  366. printf( "Bad GET_ATTRIBUTES_VALUES response for controller %p\n", dev );
  367. return false;
  368. }
  369. nAttributesLength = buf[ 2 ];
  370. if ( nAttributesLength > res )
  371. {
  372. if ( !bSuppressErrorSpew )
  373. printf( "Bad GET_ATTRIBUTES_VALUES response for controller %p\n", dev );
  374. return false;
  375. }
  376. msg = (FeatureReportMsg *)&buf[1];
  377. for ( i = 0; i < (int)msg->header.length / sizeof( ControllerAttribute ); ++i )
  378. {
  379. uint8_t unAttribute = msg->payload.getAttributes.attributes[i].attributeTag;
  380. uint32_t unValue = msg->payload.getAttributes.attributes[i].attributeValue;
  381. switch ( unAttribute )
  382. {
  383. case ATTRIB_UNIQUE_ID:
  384. break;
  385. case ATTRIB_PRODUCT_ID:
  386. break;
  387. case ATTRIB_CAPABILITIES:
  388. break;
  389. case ATTRIB_CONNECTION_INTERVAL_IN_US:
  390. unUpdateRateUS = unValue;
  391. break;
  392. default:
  393. break;
  394. }
  395. }
  396. if ( punUpdateRateUS )
  397. {
  398. *punUpdateRateUS = unUpdateRateUS;
  399. }
  400. // Clear digital button mappings
  401. buf[0] = 0;
  402. buf[1] = ID_CLEAR_DIGITAL_MAPPINGS;
  403. res = SetFeatureReport( dev, buf, 2 );
  404. if ( res < 0 )
  405. {
  406. if ( !bSuppressErrorSpew )
  407. printf( "CLEAR_DIGITAL_MAPPINGS failed for controller %p\n", dev );
  408. return false;
  409. }
  410. // Reset the default settings
  411. SDL_memset( buf, 0, 65 );
  412. buf[1] = ID_LOAD_DEFAULT_SETTINGS;
  413. buf[2] = 0;
  414. res = SetFeatureReport( dev, buf, 3 );
  415. if ( res < 0 )
  416. {
  417. if ( !bSuppressErrorSpew )
  418. printf( "LOAD_DEFAULT_SETTINGS failed for controller %p\n", dev );
  419. return false;
  420. }
  421. // Apply custom settings - clear trackpad modes (cancel mouse emulation), etc
  422. #define ADD_SETTING(SETTING, VALUE) \
  423. buf[3+nSettings*3] = SETTING; \
  424. buf[3+nSettings*3+1] = ((uint16_t)VALUE)&0xFF; \
  425. buf[3+nSettings*3+2] = ((uint16_t)VALUE)>>8; \
  426. ++nSettings;
  427. SDL_memset( buf, 0, 65 );
  428. buf[1] = ID_SET_SETTINGS_VALUES;
  429. ADD_SETTING( SETTING_WIRELESS_PACKET_VERSION, 2 );
  430. ADD_SETTING( SETTING_LEFT_TRACKPAD_MODE, TRACKPAD_NONE );
  431. #ifdef ENABLE_MOUSE_MODE
  432. ADD_SETTING( SETTING_RIGHT_TRACKPAD_MODE, TRACKPAD_ABSOLUTE_MOUSE );
  433. ADD_SETTING( SETTING_SMOOTH_ABSOLUTE_MOUSE, 1 );
  434. ADD_SETTING( SETTING_MOMENTUM_MAXIMUM_VELOCITY, 20000 ); // [0-20000] default 8000
  435. ADD_SETTING( SETTING_MOMENTUM_DECAY_AMMOUNT, 50 ); // [0-50] default 5
  436. #else
  437. ADD_SETTING( SETTING_RIGHT_TRACKPAD_MODE, TRACKPAD_NONE );
  438. ADD_SETTING( SETTING_SMOOTH_ABSOLUTE_MOUSE, 0 );
  439. #endif
  440. buf[2] = nSettings*3;
  441. res = SetFeatureReport( dev, buf, 3+nSettings*3 );
  442. if ( res < 0 )
  443. {
  444. if ( !bSuppressErrorSpew )
  445. printf( "SET_SETTINGS failed for controller %p\n", dev );
  446. return false;
  447. }
  448. #ifdef ENABLE_MOUSE_MODE
  449. // Wait for ID_CLEAR_DIGITAL_MAPPINGS to be processed on the controller
  450. bool bMappingsCleared = false;
  451. int iRetry;
  452. for ( iRetry = 0; iRetry < 2; ++iRetry )
  453. {
  454. SDL_memset( buf, 0, 65 );
  455. buf[1] = ID_GET_DIGITAL_MAPPINGS;
  456. buf[2] = 1; // one byte - requesting from index 0
  457. buf[3] = 0;
  458. res = SetFeatureReport( dev, buf, 4 );
  459. if ( res < 0 )
  460. {
  461. printf( "GET_DIGITAL_MAPPINGS failed for controller %p\n", dev );
  462. return false;
  463. }
  464. res = ReadResponse( dev, buf, ID_GET_DIGITAL_MAPPINGS );
  465. if ( res < 0 || buf[1] != ID_GET_DIGITAL_MAPPINGS )
  466. {
  467. printf( "Bad GET_DIGITAL_MAPPINGS response for controller %p\n", dev );
  468. return false;
  469. }
  470. // If the length of the digital mappings result is not 1 (index byte, no mappings) then clearing hasn't executed
  471. if ( buf[2] == 1 && buf[3] == 0xFF )
  472. {
  473. bMappingsCleared = true;
  474. break;
  475. }
  476. usleep( CONTROLLER_CONFIGURATION_DELAY_US );
  477. }
  478. if ( !bMappingsCleared && !bSuppressErrorSpew )
  479. {
  480. printf( "Warning: CLEAR_DIGITAL_MAPPINGS never completed for controller %p\n", dev );
  481. }
  482. // Set our new mappings
  483. SDL_memset( buf, 0, 65 );
  484. buf[1] = ID_SET_DIGITAL_MAPPINGS;
  485. buf[2] = 6; // 2 settings x 3 bytes
  486. buf[3] = IO_DIGITAL_BUTTON_RIGHT_TRIGGER;
  487. buf[4] = DEVICE_MOUSE;
  488. buf[5] = MOUSE_BTN_LEFT;
  489. buf[6] = IO_DIGITAL_BUTTON_LEFT_TRIGGER;
  490. buf[7] = DEVICE_MOUSE;
  491. buf[8] = MOUSE_BTN_RIGHT;
  492. res = SetFeatureReport( dev, buf, 9 );
  493. if ( res < 0 )
  494. {
  495. if ( !bSuppressErrorSpew )
  496. printf( "SET_DIGITAL_MAPPINGS failed for controller %p\n", dev );
  497. return false;
  498. }
  499. #endif // ENABLE_MOUSE_MODE
  500. return true;
  501. }
  502. //---------------------------------------------------------------------------
  503. // Read from a Steam Controller
  504. //---------------------------------------------------------------------------
  505. static int ReadSteamController( SDL_hid_device *dev, uint8_t *pData, int nDataSize )
  506. {
  507. SDL_memset( pData, 0, nDataSize );
  508. pData[ 0 ] = BLE_REPORT_NUMBER; // hid_read will also overwrite this with the same value, 0x03
  509. return SDL_hid_read( dev, pData, nDataSize );
  510. }
  511. //---------------------------------------------------------------------------
  512. // Close a Steam Controller
  513. //---------------------------------------------------------------------------
  514. static void CloseSteamController( SDL_hid_device *dev )
  515. {
  516. // Switch the Steam Controller back to lizard mode so it works with the OS
  517. unsigned char buf[65];
  518. int nSettings = 0;
  519. // Reset digital button mappings
  520. SDL_memset( buf, 0, 65 );
  521. buf[1] = ID_SET_DEFAULT_DIGITAL_MAPPINGS;
  522. SetFeatureReport( dev, buf, 2 );
  523. // Reset the default settings
  524. SDL_memset( buf, 0, 65 );
  525. buf[1] = ID_LOAD_DEFAULT_SETTINGS;
  526. buf[2] = 0;
  527. SetFeatureReport( dev, buf, 3 );
  528. // Reset mouse mode for lizard mode
  529. SDL_memset( buf, 0, 65 );
  530. buf[1] = ID_SET_SETTINGS_VALUES;
  531. ADD_SETTING( SETTING_RIGHT_TRACKPAD_MODE, TRACKPAD_ABSOLUTE_MOUSE );
  532. buf[2] = nSettings*3;
  533. SetFeatureReport( dev, buf, 3+nSettings*3 );
  534. }
  535. //---------------------------------------------------------------------------
  536. // Scale and clamp values to a range
  537. //---------------------------------------------------------------------------
  538. static float RemapValClamped( float val, float A, float B, float C, float D)
  539. {
  540. if ( A == B )
  541. {
  542. return ( val - B ) >= 0.0f ? D : C;
  543. }
  544. else
  545. {
  546. float cVal = (val - A) / (B - A);
  547. cVal = clamp( cVal, 0.0f, 1.0f );
  548. return C + (D - C) * cVal;
  549. }
  550. }
  551. //---------------------------------------------------------------------------
  552. // Rotate the pad coordinates
  553. //---------------------------------------------------------------------------
  554. static void RotatePad( int *pX, int *pY, float flAngleInRad )
  555. {
  556. short int origX = *pX, origY = *pY;
  557. *pX = (int)( SDL_cosf( flAngleInRad ) * origX - SDL_sinf( flAngleInRad ) * origY );
  558. *pY = (int)( SDL_sinf( flAngleInRad ) * origX + SDL_cosf( flAngleInRad ) * origY );
  559. }
  560. static void RotatePadShort( short *pX, short *pY, float flAngleInRad )
  561. {
  562. short int origX = *pX, origY = *pY;
  563. *pX = (short)( SDL_cosf( flAngleInRad ) * origX - SDL_sinf( flAngleInRad ) * origY );
  564. *pY = (short)( SDL_sinf( flAngleInRad ) * origX + SDL_cosf( flAngleInRad ) * origY );
  565. }
  566. //---------------------------------------------------------------------------
  567. // Format the first part of the state packet
  568. //---------------------------------------------------------------------------
  569. static void FormatStatePacketUntilGyro( SteamControllerStateInternal_t *pState, ValveControllerStatePacket_t *pStatePacket )
  570. {
  571. int nLeftPadX;
  572. int nLeftPadY;
  573. int nRightPadX;
  574. int nRightPadY;
  575. int nPadOffset;
  576. // 15 degrees in rad
  577. const float flRotationAngle = 0.261799f;
  578. SDL_memset(pState, 0, offsetof(SteamControllerStateInternal_t, sBatteryLevel));
  579. //pState->eControllerType = m_eControllerType;
  580. pState->eControllerType = 2; // k_eControllerType_SteamController;
  581. pState->unPacketNum = pStatePacket->unPacketNum;
  582. // We have a chunk of trigger data in the packet format here, so zero it out afterwards
  583. SDL_memcpy(&pState->ulButtons, &pStatePacket->ButtonTriggerData.ulButtons, 8);
  584. pState->ulButtons &= ~0xFFFF000000LL;
  585. // The firmware uses this bit to tell us what kind of data is packed into the left two axises
  586. if (pStatePacket->ButtonTriggerData.ulButtons & STEAM_LEFTPAD_FINGERDOWN_MASK)
  587. {
  588. // Finger-down bit not set; "left pad" is actually trackpad
  589. pState->sLeftPadX = pState->sPrevLeftPad[0] = pStatePacket->sLeftPadX;
  590. pState->sLeftPadY = pState->sPrevLeftPad[1] = pStatePacket->sLeftPadY;
  591. if (pStatePacket->ButtonTriggerData.ulButtons & STEAM_LEFTPAD_AND_JOYSTICK_MASK)
  592. {
  593. // The controller is interleaving both stick and pad data, both are active
  594. pState->sLeftStickX = pState->sPrevLeftStick[0];
  595. pState->sLeftStickY = pState->sPrevLeftStick[1];
  596. }
  597. else
  598. {
  599. // The stick is not active
  600. pState->sPrevLeftStick[0] = 0;
  601. pState->sPrevLeftStick[1] = 0;
  602. }
  603. }
  604. else
  605. {
  606. // Finger-down bit not set; "left pad" is actually joystick
  607. // XXX there's a firmware bug where sometimes padX is 0 and padY is a large number (acutally the battery voltage)
  608. // If that happens skip this packet and report last frames stick
  609. /*
  610. if ( m_eControllerType == k_eControllerType_SteamControllerV2 && pStatePacket->sLeftPadY > 900 )
  611. {
  612. pState->sLeftStickX = pState->sPrevLeftStick[0];
  613. pState->sLeftStickY = pState->sPrevLeftStick[1];
  614. }
  615. else
  616. */
  617. {
  618. pState->sPrevLeftStick[0] = pState->sLeftStickX = pStatePacket->sLeftPadX;
  619. pState->sPrevLeftStick[1] = pState->sLeftStickY = pStatePacket->sLeftPadY;
  620. }
  621. /*
  622. if (m_eControllerType == k_eControllerType_SteamControllerV2)
  623. {
  624. UpdateV2JoystickCap(&state);
  625. }
  626. */
  627. if (pStatePacket->ButtonTriggerData.ulButtons & STEAM_LEFTPAD_AND_JOYSTICK_MASK)
  628. {
  629. // The controller is interleaving both stick and pad data, both are active
  630. pState->sLeftPadX = pState->sPrevLeftPad[0];
  631. pState->sLeftPadY = pState->sPrevLeftPad[1];
  632. }
  633. else
  634. {
  635. // The trackpad is not active
  636. pState->sPrevLeftPad[0] = 0;
  637. pState->sPrevLeftPad[1] = 0;
  638. // Old controllers send trackpad click for joystick button when trackpad is not active
  639. if (pState->ulButtons & STEAM_BUTTON_LEFTPAD_CLICKED_MASK)
  640. {
  641. pState->ulButtons &= ~STEAM_BUTTON_LEFTPAD_CLICKED_MASK;
  642. pState->ulButtons |= STEAM_JOYSTICK_BUTTON_MASK;
  643. }
  644. }
  645. }
  646. // Fingerdown bit indicates if the packed left axis data was joystick or pad,
  647. // but if we are interleaving both, the left finger is definitely on the pad.
  648. if (pStatePacket->ButtonTriggerData.ulButtons & STEAM_LEFTPAD_AND_JOYSTICK_MASK)
  649. pState->ulButtons |= STEAM_LEFTPAD_FINGERDOWN_MASK;
  650. pState->sRightPadX = pStatePacket->sRightPadX;
  651. pState->sRightPadY = pStatePacket->sRightPadY;
  652. nLeftPadX = pState->sLeftPadX;
  653. nLeftPadY = pState->sLeftPadY;
  654. nRightPadX = pState->sRightPadX;
  655. nRightPadY = pState->sRightPadY;
  656. RotatePad(&nLeftPadX, &nLeftPadY, -flRotationAngle);
  657. RotatePad(&nRightPadX, &nRightPadY, flRotationAngle);
  658. if (pState->ulButtons & STEAM_LEFTPAD_FINGERDOWN_MASK)
  659. nPadOffset = 1000;
  660. else
  661. nPadOffset = 0;
  662. pState->sLeftPadX = clamp(nLeftPadX + nPadOffset, SDL_MIN_SINT16, SDL_MAX_SINT16);
  663. pState->sLeftPadY = clamp(nLeftPadY + nPadOffset, SDL_MIN_SINT16, SDL_MAX_SINT16);
  664. nPadOffset = 0;
  665. if (pState->ulButtons & STEAM_RIGHTPAD_FINGERDOWN_MASK)
  666. nPadOffset = 1000;
  667. else
  668. nPadOffset = 0;
  669. pState->sRightPadX = clamp(nRightPadX + nPadOffset, SDL_MIN_SINT16, SDL_MAX_SINT16);
  670. pState->sRightPadY = clamp(nRightPadY + nPadOffset, SDL_MIN_SINT16, SDL_MAX_SINT16);
  671. pState->sTriggerL = (unsigned short)RemapValClamped( (float)((pStatePacket->ButtonTriggerData.Triggers.nLeft << 7) | pStatePacket->ButtonTriggerData.Triggers.nLeft), 0, STEAMCONTROLLER_TRIGGER_MAX_ANALOG, 0, SDL_MAX_SINT16 );
  672. pState->sTriggerR = (unsigned short)RemapValClamped( (float)((pStatePacket->ButtonTriggerData.Triggers.nRight << 7) | pStatePacket->ButtonTriggerData.Triggers.nRight), 0, STEAMCONTROLLER_TRIGGER_MAX_ANALOG, 0, SDL_MAX_SINT16 );
  673. }
  674. //---------------------------------------------------------------------------
  675. // Update Steam Controller state from a BLE data packet, returns true if it parsed data
  676. //---------------------------------------------------------------------------
  677. static bool UpdateBLESteamControllerState( const uint8_t *pData, int nDataSize, SteamControllerStateInternal_t *pState )
  678. {
  679. const float flRotationAngle = 0.261799f;
  680. uint32_t ucOptionDataMask;
  681. pState->unPacketNum++;
  682. ucOptionDataMask = ( *pData++ & 0xF0 );
  683. ucOptionDataMask |= (uint32_t)(*pData++) << 8;
  684. if ( ucOptionDataMask & k_EBLEButtonChunk1 )
  685. {
  686. SDL_memcpy( &pState->ulButtons, pData, 3 );
  687. pData += 3;
  688. }
  689. if ( ucOptionDataMask & k_EBLEButtonChunk2 )
  690. {
  691. // The middle 2 bytes of the button bits over the wire are triggers when over the wire and non-SC buttons in the internal controller state packet
  692. pState->sTriggerL = (unsigned short)RemapValClamped( (float)(( pData[ 0 ] << 7 ) | pData[ 0 ]), 0, STEAMCONTROLLER_TRIGGER_MAX_ANALOG, 0, SDL_MAX_SINT16 );
  693. pState->sTriggerR = (unsigned short)RemapValClamped( (float)(( pData[ 1 ] << 7 ) | pData[ 1 ]), 0, STEAMCONTROLLER_TRIGGER_MAX_ANALOG, 0, SDL_MAX_SINT16 );
  694. pData += 2;
  695. }
  696. if ( ucOptionDataMask & k_EBLEButtonChunk3 )
  697. {
  698. uint8_t *pButtonByte = (uint8_t *)&pState->ulButtons;
  699. pButtonByte[ 5 ] = *pData++;
  700. pButtonByte[ 6 ] = *pData++;
  701. pButtonByte[ 7 ] = *pData++;
  702. }
  703. if ( ucOptionDataMask & k_EBLELeftJoystickChunk )
  704. {
  705. // This doesn't handle any of the special headcrab stuff for raw joystick which is OK for now since that FW doesn't support
  706. // this protocol yet either
  707. int nLength = sizeof( pState->sLeftStickX ) + sizeof( pState->sLeftStickY );
  708. SDL_memcpy( &pState->sLeftStickX, pData, nLength );
  709. pData += nLength;
  710. }
  711. if ( ucOptionDataMask & k_EBLELeftTrackpadChunk )
  712. {
  713. int nLength = sizeof( pState->sLeftPadX ) + sizeof( pState->sLeftPadY );
  714. int nPadOffset;
  715. SDL_memcpy( &pState->sLeftPadX, pData, nLength );
  716. if ( pState->ulButtons & STEAM_LEFTPAD_FINGERDOWN_MASK )
  717. nPadOffset = 1000;
  718. else
  719. nPadOffset = 0;
  720. RotatePadShort( &pState->sLeftPadX, &pState->sLeftPadY, -flRotationAngle );
  721. pState->sLeftPadX = clamp( pState->sLeftPadX + nPadOffset, SDL_MIN_SINT16, SDL_MAX_SINT16 );
  722. pState->sLeftPadY = clamp( pState->sLeftPadY + nPadOffset, SDL_MIN_SINT16, SDL_MAX_SINT16 );
  723. pData += nLength;
  724. }
  725. if ( ucOptionDataMask & k_EBLERightTrackpadChunk )
  726. {
  727. int nLength = sizeof( pState->sRightPadX ) + sizeof( pState->sRightPadY );
  728. int nPadOffset = 0;
  729. SDL_memcpy( &pState->sRightPadX, pData, nLength );
  730. if ( pState->ulButtons & STEAM_RIGHTPAD_FINGERDOWN_MASK )
  731. nPadOffset = 1000;
  732. else
  733. nPadOffset = 0;
  734. RotatePadShort( &pState->sRightPadX, &pState->sRightPadY, flRotationAngle );
  735. pState->sRightPadX = clamp( pState->sRightPadX + nPadOffset, SDL_MIN_SINT16, SDL_MAX_SINT16 );
  736. pState->sRightPadY = clamp( pState->sRightPadY + nPadOffset, SDL_MIN_SINT16, SDL_MAX_SINT16 );
  737. pData += nLength;
  738. }
  739. if ( ucOptionDataMask & k_EBLEIMUAccelChunk )
  740. {
  741. int nLength = sizeof( pState->sAccelX ) + sizeof( pState->sAccelY ) + sizeof( pState->sAccelZ );
  742. SDL_memcpy( &pState->sAccelX, pData, nLength );
  743. pData += nLength;
  744. }
  745. if ( ucOptionDataMask & k_EBLEIMUGyroChunk )
  746. {
  747. int nLength = sizeof( pState->sAccelX ) + sizeof( pState->sAccelY ) + sizeof( pState->sAccelZ );
  748. SDL_memcpy( &pState->sGyroX, pData, nLength );
  749. pData += nLength;
  750. }
  751. if ( ucOptionDataMask & k_EBLEIMUQuatChunk )
  752. {
  753. int nLength = sizeof( pState->sGyroQuatW ) + sizeof( pState->sGyroQuatX ) + sizeof( pState->sGyroQuatY ) + sizeof( pState->sGyroQuatZ );
  754. SDL_memcpy( &pState->sGyroQuatW, pData, nLength );
  755. pData += nLength;
  756. }
  757. return true;
  758. }
  759. //---------------------------------------------------------------------------
  760. // Update Steam Controller state from a data packet, returns true if it parsed data
  761. //---------------------------------------------------------------------------
  762. static bool UpdateSteamControllerState( const uint8_t *pData, int nDataSize, SteamControllerStateInternal_t *pState )
  763. {
  764. ValveInReport_t *pInReport = (ValveInReport_t*)pData;
  765. if ( pInReport->header.unReportVersion != k_ValveInReportMsgVersion )
  766. {
  767. if ( ( pData[ 0 ] & 0x0F ) == k_EBLEReportState )
  768. {
  769. return UpdateBLESteamControllerState( pData, nDataSize, pState );
  770. }
  771. return false;
  772. }
  773. if ( ( pInReport->header.ucType != ID_CONTROLLER_STATE ) &&
  774. ( pInReport->header.ucType != ID_CONTROLLER_BLE_STATE ) )
  775. {
  776. return false;
  777. }
  778. if ( pInReport->header.ucType == ID_CONTROLLER_STATE )
  779. {
  780. ValveControllerStatePacket_t *pStatePacket = &pInReport->payload.controllerState;
  781. // No new data to process; indicate that we received a state packet, but otherwise do nothing.
  782. if ( pState->unPacketNum == pStatePacket->unPacketNum )
  783. return true;
  784. FormatStatePacketUntilGyro( pState, pStatePacket );
  785. pState->sAccelX = pStatePacket->sAccelX;
  786. pState->sAccelY = pStatePacket->sAccelY;
  787. pState->sAccelZ = pStatePacket->sAccelZ;
  788. pState->sGyroQuatW = pStatePacket->sGyroQuatW;
  789. pState->sGyroQuatX = pStatePacket->sGyroQuatX;
  790. pState->sGyroQuatY = pStatePacket->sGyroQuatY;
  791. pState->sGyroQuatZ = pStatePacket->sGyroQuatZ;
  792. pState->sGyroX = pStatePacket->sGyroX;
  793. pState->sGyroY = pStatePacket->sGyroY;
  794. pState->sGyroZ = pStatePacket->sGyroZ;
  795. }
  796. else if ( pInReport->header.ucType == ID_CONTROLLER_BLE_STATE )
  797. {
  798. ValveControllerBLEStatePacket_t *pBLEStatePacket = &pInReport->payload.controllerBLEState;
  799. ValveControllerStatePacket_t *pStatePacket = &pInReport->payload.controllerState;
  800. // No new data to process; indicate that we received a state packet, but otherwise do nothing.
  801. if ( pState->unPacketNum == pStatePacket->unPacketNum )
  802. return true;
  803. FormatStatePacketUntilGyro( pState, pStatePacket );
  804. switch ( pBLEStatePacket->ucGyroDataType )
  805. {
  806. case 1:
  807. pState->sGyroQuatW = (( float ) pBLEStatePacket->sGyro[0]);
  808. pState->sGyroQuatX = (( float ) pBLEStatePacket->sGyro[1]);
  809. pState->sGyroQuatY = (( float ) pBLEStatePacket->sGyro[2]);
  810. pState->sGyroQuatZ = (( float ) pBLEStatePacket->sGyro[3]);
  811. break;
  812. case 2:
  813. pState->sAccelX = pBLEStatePacket->sGyro[0];
  814. pState->sAccelY = pBLEStatePacket->sGyro[1];
  815. pState->sAccelZ = pBLEStatePacket->sGyro[2];
  816. break;
  817. case 3:
  818. pState->sGyroX = pBLEStatePacket->sGyro[0];
  819. pState->sGyroY = pBLEStatePacket->sGyro[1];
  820. pState->sGyroZ = pBLEStatePacket->sGyro[2];
  821. break;
  822. default:
  823. break;
  824. }
  825. }
  826. return true;
  827. }
  828. /*****************************************************************************************************/
  829. typedef struct {
  830. SDL_bool report_sensors;
  831. uint32_t update_rate_in_us;
  832. Uint32 timestamp_us;
  833. SteamControllerPacketAssembler m_assembler;
  834. SteamControllerStateInternal_t m_state;
  835. SteamControllerStateInternal_t m_last_state;
  836. } SDL_DriverSteam_Context;
  837. static void
  838. HIDAPI_DriverSteam_RegisterHints(SDL_HintCallback callback, void *userdata)
  839. {
  840. SDL_AddHintCallback(SDL_HINT_JOYSTICK_HIDAPI_STEAM, callback, userdata);
  841. }
  842. static void
  843. HIDAPI_DriverSteam_UnregisterHints(SDL_HintCallback callback, void *userdata)
  844. {
  845. SDL_DelHintCallback(SDL_HINT_JOYSTICK_HIDAPI_STEAM, callback, userdata);
  846. }
  847. static SDL_bool
  848. HIDAPI_DriverSteam_IsEnabled(void)
  849. {
  850. return SDL_GetHintBoolean(SDL_HINT_JOYSTICK_HIDAPI_STEAM, SDL_FALSE);
  851. }
  852. static SDL_bool
  853. HIDAPI_DriverSteam_IsSupportedDevice(SDL_HIDAPI_Device *device, 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)
  854. {
  855. return SDL_IsJoystickSteamController(vendor_id, product_id);
  856. }
  857. static SDL_bool
  858. HIDAPI_DriverSteam_InitDevice(SDL_HIDAPI_Device *device)
  859. {
  860. SDL_DriverSteam_Context *ctx;
  861. ctx = (SDL_DriverSteam_Context *)SDL_calloc(1, sizeof(*ctx));
  862. if (!ctx) {
  863. SDL_OutOfMemory();
  864. return SDL_FALSE;
  865. }
  866. device->context = ctx;
  867. #if defined(__WIN32__)
  868. if (device->serial) {
  869. /* We get a garbage serial number on Windows */
  870. SDL_free(device->serial);
  871. device->serial = NULL;
  872. }
  873. #endif /* __WIN32__ */
  874. HIDAPI_SetDeviceName(device, "Steam Controller");
  875. return HIDAPI_JoystickConnected(device, NULL);
  876. }
  877. static int
  878. HIDAPI_DriverSteam_GetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_JoystickID instance_id)
  879. {
  880. return -1;
  881. }
  882. static void
  883. HIDAPI_DriverSteam_SetDevicePlayerIndex(SDL_HIDAPI_Device *device, SDL_JoystickID instance_id, int player_index)
  884. {
  885. }
  886. static SDL_bool
  887. HIDAPI_DriverSteam_OpenJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
  888. {
  889. SDL_DriverSteam_Context *ctx = (SDL_DriverSteam_Context *)device->context;
  890. float update_rate_in_hz = 0.0f;
  891. ctx->report_sensors = SDL_FALSE;
  892. SDL_zero(ctx->m_assembler);
  893. SDL_zero(ctx->m_state);
  894. SDL_zero(ctx->m_last_state);
  895. if (!ResetSteamController(device->dev, false, &ctx->update_rate_in_us)) {
  896. SDL_SetError("Couldn't reset controller");
  897. return SDL_FALSE;
  898. }
  899. if (ctx->update_rate_in_us > 0) {
  900. update_rate_in_hz = 1000000.0f / ctx->update_rate_in_us;
  901. }
  902. InitializeSteamControllerPacketAssembler(&ctx->m_assembler);
  903. /* Initialize the joystick capabilities */
  904. joystick->nbuttons = 17;
  905. joystick->naxes = SDL_CONTROLLER_AXIS_MAX;
  906. SDL_PrivateJoystickAddSensor(joystick, SDL_SENSOR_GYRO, update_rate_in_hz);
  907. SDL_PrivateJoystickAddSensor(joystick, SDL_SENSOR_ACCEL, update_rate_in_hz);
  908. return SDL_TRUE;
  909. }
  910. static int
  911. HIDAPI_DriverSteam_RumbleJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble)
  912. {
  913. /* You should use the full Steam Input API for rumble support */
  914. return SDL_Unsupported();
  915. }
  916. static int
  917. HIDAPI_DriverSteam_RumbleJoystickTriggers(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble)
  918. {
  919. return SDL_Unsupported();
  920. }
  921. static Uint32
  922. HIDAPI_DriverSteam_GetJoystickCapabilities(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
  923. {
  924. /* You should use the full Steam Input API for extended capabilities */
  925. return 0;
  926. }
  927. static int
  928. HIDAPI_DriverSteam_SetJoystickLED(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue)
  929. {
  930. /* You should use the full Steam Input API for LED support */
  931. return SDL_Unsupported();
  932. }
  933. static int
  934. HIDAPI_DriverSteam_SendJoystickEffect(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, const void *data, int size)
  935. {
  936. return SDL_Unsupported();
  937. }
  938. static int
  939. HIDAPI_DriverSteam_SetSensorsEnabled(SDL_HIDAPI_Device *device, SDL_Joystick *joystick, SDL_bool enabled)
  940. {
  941. SDL_DriverSteam_Context *ctx = (SDL_DriverSteam_Context *)device->context;
  942. unsigned char buf[65];
  943. int nSettings = 0;
  944. SDL_memset( buf, 0, 65 );
  945. buf[1] = ID_SET_SETTINGS_VALUES;
  946. if (enabled) {
  947. ADD_SETTING( SETTING_GYRO_MODE, 0x18 /* SETTING_GYRO_SEND_RAW_ACCEL | SETTING_GYRO_MODE_SEND_RAW_GYRO */ );
  948. } else {
  949. ADD_SETTING( SETTING_GYRO_MODE, 0x00 /* SETTING_GYRO_MODE_OFF */ );
  950. }
  951. buf[2] = nSettings*3;
  952. if (SetFeatureReport( device->dev, buf, 3+nSettings*3 ) < 0) {
  953. return SDL_SetError("Couldn't write feature report");
  954. }
  955. ctx->report_sensors = enabled;
  956. return 0;
  957. }
  958. static SDL_bool
  959. HIDAPI_DriverSteam_UpdateDevice(SDL_HIDAPI_Device *device)
  960. {
  961. SDL_DriverSteam_Context *ctx = (SDL_DriverSteam_Context *)device->context;
  962. SDL_Joystick *joystick = NULL;
  963. if (device->num_joysticks > 0) {
  964. joystick = SDL_JoystickFromInstanceID(device->joysticks[0]);
  965. } else {
  966. return SDL_FALSE;
  967. }
  968. for (;;)
  969. {
  970. uint8_t data[128];
  971. int r, nPacketLength;
  972. const Uint8 *pPacket;
  973. r = ReadSteamController(device->dev, data, sizeof(data));
  974. if (r == 0) {
  975. break;
  976. }
  977. if (!joystick) {
  978. continue;
  979. }
  980. nPacketLength = 0;
  981. if (r > 0) {
  982. nPacketLength = WriteSegmentToSteamControllerPacketAssembler(&ctx->m_assembler, data, r);
  983. }
  984. pPacket = ctx->m_assembler.uBuffer;
  985. if (nPacketLength > 0 && UpdateSteamControllerState(pPacket, nPacketLength, &ctx->m_state)) {
  986. if (ctx->m_state.ulButtons != ctx->m_last_state.ulButtons) {
  987. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_A,
  988. (ctx->m_state.ulButtons & STEAM_BUTTON_3_MASK) ? SDL_PRESSED : SDL_RELEASED);
  989. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_B,
  990. (ctx->m_state.ulButtons & STEAM_BUTTON_1_MASK) ? SDL_PRESSED : SDL_RELEASED);
  991. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_X,
  992. (ctx->m_state.ulButtons & STEAM_BUTTON_2_MASK) ? SDL_PRESSED : SDL_RELEASED);
  993. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_Y,
  994. (ctx->m_state.ulButtons & STEAM_BUTTON_0_MASK) ? SDL_PRESSED : SDL_RELEASED);
  995. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_LEFTSHOULDER,
  996. (ctx->m_state.ulButtons & STEAM_LEFT_BUMPER_MASK) ? SDL_PRESSED : SDL_RELEASED);
  997. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_RIGHTSHOULDER,
  998. (ctx->m_state.ulButtons & STEAM_RIGHT_BUMPER_MASK) ? SDL_PRESSED : SDL_RELEASED);
  999. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_BACK,
  1000. (ctx->m_state.ulButtons & STEAM_BUTTON_MENU_MASK) ? SDL_PRESSED : SDL_RELEASED);
  1001. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_START,
  1002. (ctx->m_state.ulButtons & STEAM_BUTTON_ESCAPE_MASK) ? SDL_PRESSED : SDL_RELEASED);
  1003. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_GUIDE,
  1004. (ctx->m_state.ulButtons & STEAM_BUTTON_STEAM_MASK) ? SDL_PRESSED : SDL_RELEASED);
  1005. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_LEFTSTICK,
  1006. (ctx->m_state.ulButtons & STEAM_JOYSTICK_BUTTON_MASK) ? SDL_PRESSED : SDL_RELEASED);
  1007. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_MISC1 + 0,
  1008. (ctx->m_state.ulButtons & STEAM_BUTTON_BACK_LEFT_MASK) ? SDL_PRESSED : SDL_RELEASED);
  1009. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_MISC1 + 1,
  1010. (ctx->m_state.ulButtons & STEAM_BUTTON_BACK_RIGHT_MASK) ? SDL_PRESSED : SDL_RELEASED);
  1011. }
  1012. {
  1013. /* Minimum distance from center of pad to register a direction */
  1014. const int kPadDeadZone = 10000;
  1015. /* Pad coordinates are like math grid coordinates: negative is bottom left */
  1016. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_UP,
  1017. (ctx->m_state.sLeftPadY > kPadDeadZone) ? SDL_PRESSED : SDL_RELEASED);
  1018. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_DOWN,
  1019. (ctx->m_state.sLeftPadY < -kPadDeadZone) ? SDL_PRESSED : SDL_RELEASED);
  1020. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_LEFT,
  1021. (ctx->m_state.sLeftPadX < -kPadDeadZone) ? SDL_PRESSED : SDL_RELEASED);
  1022. SDL_PrivateJoystickButton(joystick, SDL_CONTROLLER_BUTTON_DPAD_RIGHT,
  1023. (ctx->m_state.sLeftPadX > kPadDeadZone) ? SDL_PRESSED : SDL_RELEASED);
  1024. }
  1025. SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_TRIGGERLEFT, (int)ctx->m_state.sTriggerL * 2 - 32768);
  1026. SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_TRIGGERRIGHT, (int)ctx->m_state.sTriggerR * 2 - 32768);
  1027. SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_LEFTX, ctx->m_state.sLeftStickX);
  1028. SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_LEFTY, ~ctx->m_state.sLeftStickY);
  1029. SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_RIGHTX, ctx->m_state.sRightPadX);
  1030. SDL_PrivateJoystickAxis(joystick, SDL_CONTROLLER_AXIS_RIGHTY, ~ctx->m_state.sRightPadY);
  1031. if (ctx->report_sensors) {
  1032. float values[3];
  1033. ctx->timestamp_us += ctx->update_rate_in_us;
  1034. values[0] = (ctx->m_state.sGyroX / 32768.0f) * (2000.0f * (SDL_PI_F / 180.0f));
  1035. values[1] = (ctx->m_state.sGyroZ / 32768.0f) * (2000.0f * (SDL_PI_F / 180.0f));
  1036. values[2] = (ctx->m_state.sGyroY / 32768.0f) * (2000.0f * (SDL_PI_F / 180.0f));
  1037. SDL_PrivateJoystickSensor(joystick, SDL_SENSOR_GYRO, ctx->timestamp_us, values, 3);
  1038. values[0] = (ctx->m_state.sAccelX / 32768.0f) * 2.0f * SDL_STANDARD_GRAVITY;
  1039. values[1] = (ctx->m_state.sAccelZ / 32768.0f) * 2.0f * SDL_STANDARD_GRAVITY;
  1040. values[2] = (-ctx->m_state.sAccelY / 32768.0f) * 2.0f * SDL_STANDARD_GRAVITY;
  1041. SDL_PrivateJoystickSensor(joystick, SDL_SENSOR_ACCEL, ctx->timestamp_us, values, 3);
  1042. }
  1043. ctx->m_last_state = ctx->m_state;
  1044. }
  1045. if (r <= 0) {
  1046. /* Failed to read from controller */
  1047. HIDAPI_JoystickDisconnected(device, device->joysticks[0]);
  1048. return SDL_FALSE;
  1049. }
  1050. }
  1051. return SDL_TRUE;
  1052. }
  1053. static void
  1054. HIDAPI_DriverSteam_CloseJoystick(SDL_HIDAPI_Device *device, SDL_Joystick *joystick)
  1055. {
  1056. CloseSteamController(device->dev);
  1057. }
  1058. static void
  1059. HIDAPI_DriverSteam_FreeDevice(SDL_HIDAPI_Device *device)
  1060. {
  1061. }
  1062. SDL_HIDAPI_DeviceDriver SDL_HIDAPI_DriverSteam =
  1063. {
  1064. SDL_HINT_JOYSTICK_HIDAPI_STEAM,
  1065. SDL_TRUE,
  1066. HIDAPI_DriverSteam_RegisterHints,
  1067. HIDAPI_DriverSteam_UnregisterHints,
  1068. HIDAPI_DriverSteam_IsEnabled,
  1069. HIDAPI_DriverSteam_IsSupportedDevice,
  1070. HIDAPI_DriverSteam_InitDevice,
  1071. HIDAPI_DriverSteam_GetDevicePlayerIndex,
  1072. HIDAPI_DriverSteam_SetDevicePlayerIndex,
  1073. HIDAPI_DriverSteam_UpdateDevice,
  1074. HIDAPI_DriverSteam_OpenJoystick,
  1075. HIDAPI_DriverSteam_RumbleJoystick,
  1076. HIDAPI_DriverSteam_RumbleJoystickTriggers,
  1077. HIDAPI_DriverSteam_GetJoystickCapabilities,
  1078. HIDAPI_DriverSteam_SetJoystickLED,
  1079. HIDAPI_DriverSteam_SendJoystickEffect,
  1080. HIDAPI_DriverSteam_SetSensorsEnabled,
  1081. HIDAPI_DriverSteam_CloseJoystick,
  1082. HIDAPI_DriverSteam_FreeDevice,
  1083. };
  1084. #endif /* SDL_JOYSTICK_HIDAPI_STEAM */
  1085. #endif /* SDL_JOYSTICK_HIDAPI */
  1086. /* vi: set ts=4 sw=4 expandtab: */