🛠️🐜 Antkeeper superbuild with dependencies included https://antkeeper.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

451 lines
17 KiB

  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. /**
  19. * \file SDL_hidapi.h
  20. *
  21. * Header file for SDL HIDAPI functions.
  22. *
  23. * This is an adaptation of the original HIDAPI interface by Alan Ott,
  24. * and includes source code licensed under the following BSD license:
  25. *
  26. Copyright (c) 2010, Alan Ott, Signal 11 Software
  27. All rights reserved.
  28. Redistribution and use in source and binary forms, with or without
  29. modification, are permitted provided that the following conditions are met:
  30. * Redistributions of source code must retain the above copyright notice,
  31. this list of conditions and the following disclaimer.
  32. * Redistributions in binary form must reproduce the above copyright
  33. notice, this list of conditions and the following disclaimer in the
  34. documentation and/or other materials provided with the distribution.
  35. * Neither the name of Signal 11 Software nor the names of its
  36. contributors may be used to endorse or promote products derived from
  37. this software without specific prior written permission.
  38. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  39. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  41. ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  42. LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  43. CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  44. SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  45. INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  46. CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  47. ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  48. POSSIBILITY OF SUCH DAMAGE.
  49. *
  50. * If you would like a version of SDL without this code, you can build SDL
  51. * with SDL_HIDAPI_DISABLED defined to 1. You might want to do this for example
  52. * on iOS or tvOS to avoid a dependency on the CoreBluetooth framework.
  53. */
  54. #ifndef SDL_hidapi_h_
  55. #define SDL_hidapi_h_
  56. #include "SDL_stdinc.h"
  57. #include "begin_code.h"
  58. /* Set up for C function definitions, even when using C++ */
  59. #ifdef __cplusplus
  60. extern "C" {
  61. #endif
  62. /**
  63. * \brief A handle representing an open HID device
  64. */
  65. struct SDL_hid_device_;
  66. typedef struct SDL_hid_device_ SDL_hid_device; /**< opaque hidapi structure */
  67. /** hidapi info structure */
  68. /**
  69. * \brief Information about a connected HID device
  70. */
  71. typedef struct SDL_hid_device_info
  72. {
  73. /** Platform-specific device path */
  74. char *path;
  75. /** Device Vendor ID */
  76. unsigned short vendor_id;
  77. /** Device Product ID */
  78. unsigned short product_id;
  79. /** Serial Number */
  80. wchar_t *serial_number;
  81. /** Device Release Number in binary-coded decimal,
  82. also known as Device Version Number */
  83. unsigned short release_number;
  84. /** Manufacturer String */
  85. wchar_t *manufacturer_string;
  86. /** Product string */
  87. wchar_t *product_string;
  88. /** Usage Page for this Device/Interface
  89. (Windows/Mac only). */
  90. unsigned short usage_page;
  91. /** Usage for this Device/Interface
  92. (Windows/Mac only).*/
  93. unsigned short usage;
  94. /** The USB interface which this logical device
  95. represents.
  96. * Valid on both Linux implementations in all cases.
  97. * Valid on the Windows implementation only if the device
  98. contains more than one interface. */
  99. int interface_number;
  100. /** Additional information about the USB interface.
  101. Valid on libusb and Android implementations. */
  102. int interface_class;
  103. int interface_subclass;
  104. int interface_protocol;
  105. /** Pointer to the next device */
  106. struct SDL_hid_device_info *next;
  107. } SDL_hid_device_info;
  108. /**
  109. * Initialize the HIDAPI library.
  110. *
  111. * This function initializes the HIDAPI library. Calling it is not strictly
  112. * necessary, as it will be called automatically by SDL_hid_enumerate() and
  113. * any of the SDL_hid_open_*() functions if it is needed. This function should
  114. * be called at the beginning of execution however, if there is a chance of
  115. * HIDAPI handles being opened by different threads simultaneously.
  116. *
  117. * Each call to this function should have a matching call to SDL_hid_exit()
  118. *
  119. * \returns 0 on success and -1 on error.
  120. *
  121. * \since This function is available since SDL 2.0.18.
  122. *
  123. * \sa SDL_hid_exit
  124. */
  125. extern DECLSPEC int SDLCALL SDL_hid_init(void);
  126. /**
  127. * Finalize the HIDAPI library.
  128. *
  129. * This function frees all of the static data associated with HIDAPI. It
  130. * should be called at the end of execution to avoid memory leaks.
  131. *
  132. * \returns 0 on success and -1 on error.
  133. *
  134. * \since This function is available since SDL 2.0.18.
  135. *
  136. * \sa SDL_hid_init
  137. */
  138. extern DECLSPEC int SDLCALL SDL_hid_exit(void);
  139. /**
  140. * Check to see if devices may have been added or removed.
  141. *
  142. * Enumerating the HID devices is an expensive operation, so you can call this
  143. * to see if there have been any system device changes since the last call to
  144. * this function. A change in the counter returned doesn't necessarily mean
  145. * that anything has changed, but you can call SDL_hid_enumerate() to get an
  146. * updated device list.
  147. *
  148. * Calling this function for the first time may cause a thread or other system
  149. * resource to be allocated to track device change notifications.
  150. *
  151. * \returns a change counter that is incremented with each potential device
  152. * change, or 0 if device change detection isn't available.
  153. *
  154. * \since This function is available since SDL 2.0.18.
  155. *
  156. * \sa SDL_hid_enumerate
  157. */
  158. extern DECLSPEC Uint32 SDLCALL SDL_hid_device_change_count(void);
  159. /**
  160. * Enumerate the HID Devices.
  161. *
  162. * This function returns a linked list of all the HID devices attached to the
  163. * system which match vendor_id and product_id. If `vendor_id` is set to 0
  164. * then any vendor matches. If `product_id` is set to 0 then any product
  165. * matches. If `vendor_id` and `product_id` are both set to 0, then all HID
  166. * devices will be returned.
  167. *
  168. * \param vendor_id The Vendor ID (VID) of the types of device to open.
  169. * \param product_id The Product ID (PID) of the types of device to open.
  170. * \returns a pointer to a linked list of type SDL_hid_device_info, containing
  171. * information about the HID devices attached to the system, or NULL
  172. * in the case of failure. Free this linked list by calling
  173. * SDL_hid_free_enumeration().
  174. *
  175. * \since This function is available since SDL 2.0.18.
  176. *
  177. * \sa SDL_hid_device_change_count
  178. */
  179. extern DECLSPEC SDL_hid_device_info * SDLCALL SDL_hid_enumerate(unsigned short vendor_id, unsigned short product_id);
  180. /**
  181. * Free an enumeration Linked List
  182. *
  183. * This function frees a linked list created by SDL_hid_enumerate().
  184. *
  185. * \param devs Pointer to a list of struct_device returned from
  186. * SDL_hid_enumerate().
  187. *
  188. * \since This function is available since SDL 2.0.18.
  189. */
  190. extern DECLSPEC void SDLCALL SDL_hid_free_enumeration(SDL_hid_device_info *devs);
  191. /**
  192. * Open a HID device using a Vendor ID (VID), Product ID (PID) and optionally
  193. * a serial number.
  194. *
  195. * If `serial_number` is NULL, the first device with the specified VID and PID
  196. * is opened.
  197. *
  198. * \param vendor_id The Vendor ID (VID) of the device to open.
  199. * \param product_id The Product ID (PID) of the device to open.
  200. * \param serial_number The Serial Number of the device to open (Optionally
  201. * NULL).
  202. * \returns a pointer to a SDL_hid_device object on success or NULL on
  203. * failure.
  204. *
  205. * \since This function is available since SDL 2.0.18.
  206. */
  207. extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number);
  208. /**
  209. * Open a HID device by its path name.
  210. *
  211. * The path name be determined by calling SDL_hid_enumerate(), or a
  212. * platform-specific path name can be used (eg: /dev/hidraw0 on Linux).
  213. *
  214. * \param path The path name of the device to open
  215. * \returns a pointer to a SDL_hid_device object on success or NULL on
  216. * failure.
  217. *
  218. * \since This function is available since SDL 2.0.18.
  219. */
  220. extern DECLSPEC SDL_hid_device * SDLCALL SDL_hid_open_path(const char *path, int bExclusive /* = false */);
  221. /**
  222. * Write an Output report to a HID device.
  223. *
  224. * The first byte of `data` must contain the Report ID. For devices which only
  225. * support a single report, this must be set to 0x0. The remaining bytes
  226. * contain the report data. Since the Report ID is mandatory, calls to
  227. * SDL_hid_write() will always contain one more byte than the report contains.
  228. * For example, if a hid report is 16 bytes long, 17 bytes must be passed to
  229. * SDL_hid_write(), the Report ID (or 0x0, for devices with a single report),
  230. * followed by the report data (16 bytes). In this example, the length passed
  231. * in would be 17.
  232. *
  233. * SDL_hid_write() will send the data on the first OUT endpoint, if one
  234. * exists. If it does not, it will send the data through the Control Endpoint
  235. * (Endpoint 0).
  236. *
  237. * \param dev A device handle returned from SDL_hid_open().
  238. * \param data The data to send, including the report number as the first
  239. * byte.
  240. * \param length The length in bytes of the data to send.
  241. * \returns the actual number of bytes written and -1 on error.
  242. *
  243. * \since This function is available since SDL 2.0.18.
  244. */
  245. extern DECLSPEC int SDLCALL SDL_hid_write(SDL_hid_device *dev, const unsigned char *data, size_t length);
  246. /**
  247. * Read an Input report from a HID device with timeout.
  248. *
  249. * Input reports are returned to the host through the INTERRUPT IN endpoint.
  250. * The first byte will contain the Report number if the device uses numbered
  251. * reports.
  252. *
  253. * \param dev A device handle returned from SDL_hid_open().
  254. * \param data A buffer to put the read data into.
  255. * \param length The number of bytes to read. For devices with multiple
  256. * reports, make sure to read an extra byte for the report
  257. * number.
  258. * \param milliseconds timeout in milliseconds or -1 for blocking wait.
  259. * \returns the actual number of bytes read and -1 on error. If no packet was
  260. * available to be read within the timeout period, this function
  261. * returns 0.
  262. *
  263. * \since This function is available since SDL 2.0.18.
  264. */
  265. extern DECLSPEC int SDLCALL SDL_hid_read_timeout(SDL_hid_device *dev, unsigned char *data, size_t length, int milliseconds);
  266. /**
  267. * Read an Input report from a HID device.
  268. *
  269. * Input reports are returned to the host through the INTERRUPT IN endpoint.
  270. * The first byte will contain the Report number if the device uses numbered
  271. * reports.
  272. *
  273. * \param dev A device handle returned from SDL_hid_open().
  274. * \param data A buffer to put the read data into.
  275. * \param length The number of bytes to read. For devices with multiple
  276. * reports, make sure to read an extra byte for the report
  277. * number.
  278. * \returns the actual number of bytes read and -1 on error. If no packet was
  279. * available to be read and the handle is in non-blocking mode, this
  280. * function returns 0.
  281. *
  282. * \since This function is available since SDL 2.0.18.
  283. */
  284. extern DECLSPEC int SDLCALL SDL_hid_read(SDL_hid_device *dev, unsigned char *data, size_t length);
  285. /**
  286. * Set the device handle to be non-blocking.
  287. *
  288. * In non-blocking mode calls to SDL_hid_read() will return immediately with a
  289. * value of 0 if there is no data to be read. In blocking mode, SDL_hid_read()
  290. * will wait (block) until there is data to read before returning.
  291. *
  292. * Nonblocking can be turned on and off at any time.
  293. *
  294. * \param dev A device handle returned from SDL_hid_open().
  295. * \param nonblock enable or not the nonblocking reads - 1 to enable
  296. * nonblocking - 0 to disable nonblocking.
  297. * \returns 0 on success and -1 on error.
  298. *
  299. * \since This function is available since SDL 2.0.18.
  300. */
  301. extern DECLSPEC int SDLCALL SDL_hid_set_nonblocking(SDL_hid_device *dev, int nonblock);
  302. /**
  303. * Send a Feature report to the device.
  304. *
  305. * Feature reports are sent over the Control endpoint as a Set_Report
  306. * transfer. The first byte of `data` must contain the Report ID. For devices
  307. * which only support a single report, this must be set to 0x0. The remaining
  308. * bytes contain the report data. Since the Report ID is mandatory, calls to
  309. * SDL_hid_send_feature_report() will always contain one more byte than the
  310. * report contains. For example, if a hid report is 16 bytes long, 17 bytes
  311. * must be passed to SDL_hid_send_feature_report(): the Report ID (or 0x0, for
  312. * devices which do not use numbered reports), followed by the report data (16
  313. * bytes). In this example, the length passed in would be 17.
  314. *
  315. * \param dev A device handle returned from SDL_hid_open().
  316. * \param data The data to send, including the report number as the first
  317. * byte.
  318. * \param length The length in bytes of the data to send, including the report
  319. * number.
  320. * \returns the actual number of bytes written and -1 on error.
  321. *
  322. * \since This function is available since SDL 2.0.18.
  323. */
  324. extern DECLSPEC int SDLCALL SDL_hid_send_feature_report(SDL_hid_device *dev, const unsigned char *data, size_t length);
  325. /**
  326. * Get a feature report from a HID device.
  327. *
  328. * Set the first byte of `data` to the Report ID of the report to be read.
  329. * Make sure to allow space for this extra byte in `data`. Upon return, the
  330. * first byte will still contain the Report ID, and the report data will start
  331. * in data[1].
  332. *
  333. * \param dev A device handle returned from SDL_hid_open().
  334. * \param data A buffer to put the read data into, including the Report ID.
  335. * Set the first byte of `data` to the Report ID of the report to
  336. * be read, or set it to zero if your device does not use numbered
  337. * reports.
  338. * \param length The number of bytes to read, including an extra byte for the
  339. * report ID. The buffer can be longer than the actual report.
  340. * \returns the number of bytes read plus one for the report ID (which is
  341. * still in the first byte), or -1 on error.
  342. *
  343. * \since This function is available since SDL 2.0.18.
  344. */
  345. extern DECLSPEC int SDLCALL SDL_hid_get_feature_report(SDL_hid_device *dev, unsigned char *data, size_t length);
  346. /**
  347. * Close a HID device.
  348. *
  349. * \param dev A device handle returned from SDL_hid_open().
  350. *
  351. * \since This function is available since SDL 2.0.18.
  352. */
  353. extern DECLSPEC void SDLCALL SDL_hid_close(SDL_hid_device *dev);
  354. /**
  355. * Get The Manufacturer String from a HID device.
  356. *
  357. * \param dev A device handle returned from SDL_hid_open().
  358. * \param string A wide string buffer to put the data into.
  359. * \param maxlen The length of the buffer in multiples of wchar_t.
  360. * \returns 0 on success and -1 on error.
  361. *
  362. * \since This function is available since SDL 2.0.18.
  363. */
  364. extern DECLSPEC int SDLCALL SDL_hid_get_manufacturer_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen);
  365. /**
  366. * Get The Product String from a HID device.
  367. *
  368. * \param dev A device handle returned from SDL_hid_open().
  369. * \param string A wide string buffer to put the data into.
  370. * \param maxlen The length of the buffer in multiples of wchar_t.
  371. * \returns 0 on success and -1 on error.
  372. *
  373. * \since This function is available since SDL 2.0.18.
  374. */
  375. extern DECLSPEC int SDLCALL SDL_hid_get_product_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen);
  376. /**
  377. * Get The Serial Number String from a HID device.
  378. *
  379. * \param dev A device handle returned from SDL_hid_open().
  380. * \param string A wide string buffer to put the data into.
  381. * \param maxlen The length of the buffer in multiples of wchar_t.
  382. * \returns 0 on success and -1 on error.
  383. *
  384. * \since This function is available since SDL 2.0.18.
  385. */
  386. extern DECLSPEC int SDLCALL SDL_hid_get_serial_number_string(SDL_hid_device *dev, wchar_t *string, size_t maxlen);
  387. /**
  388. * Get a string from a HID device, based on its string index.
  389. *
  390. * \param dev A device handle returned from SDL_hid_open().
  391. * \param string_index The index of the string to get.
  392. * \param string A wide string buffer to put the data into.
  393. * \param maxlen The length of the buffer in multiples of wchar_t.
  394. * \returns 0 on success and -1 on error.
  395. *
  396. * \since This function is available since SDL 2.0.18.
  397. */
  398. extern DECLSPEC int SDLCALL SDL_hid_get_indexed_string(SDL_hid_device *dev, int string_index, wchar_t *string, size_t maxlen);
  399. /**
  400. * Start or stop a BLE scan on iOS and tvOS to pair Steam Controllers
  401. *
  402. * \param active SDL_TRUE to start the scan, SDL_FALSE to stop the scan
  403. *
  404. * \since This function is available since SDL 2.0.18.
  405. */
  406. extern DECLSPEC void SDLCALL SDL_hid_ble_scan(SDL_bool active);
  407. /* Ends C function definitions when using C++ */
  408. #ifdef __cplusplus
  409. }
  410. #endif
  411. #include "close_code.h"
  412. #endif /* SDL_hidapi_h_ */
  413. /* vi: set sts=4 ts=4 sw=4 expandtab: */