From ddebae0877a3c61da38065bdaf2007e756dec1d4 Mon Sep 17 00:00:00 2001 From: imi415 Date: Sat, 28 May 2022 20:19:43 +0800 Subject: [PATCH] Initial commit. --- CMakeLists.txt | 0 LICENSE.txt | 1 + include/lpcusbsio.h | 794 +++++++++++++++ include/lpcusbsio_protocol.h | 397 ++++++++ license/BSD-3-clause.txt | 11 + license/LICENSE-hidapi-bsd.txt | 26 + license/SoftwareContentRegister.txt | 58 ++ src/hid_api/AUTHORS.txt | 19 + src/hid_api/LICENSE-bsd.txt | 26 + src/hid_api/LICENSE-gpl3.txt | 674 +++++++++++++ src/hid_api/LICENSE-orig.txt | 9 + src/hid_api/LICENSE.txt | 13 + src/hid_api/ORIGIN.url | 2 + src/hid_api/hidapi/hidapi.h | 472 +++++++++ src/hid_api/linux/hid.c | 1009 +++++++++++++++++++ src/hid_api/mac/hid.c | 1242 ++++++++++++++++++++++++ src/hid_api/windows/hid.c | 1002 +++++++++++++++++++ src/lpcusbsio.c | 1390 +++++++++++++++++++++++++++ 18 files changed, 7145 insertions(+) create mode 100644 CMakeLists.txt create mode 100644 LICENSE.txt create mode 100644 include/lpcusbsio.h create mode 100644 include/lpcusbsio_protocol.h create mode 100644 license/BSD-3-clause.txt create mode 100644 license/LICENSE-hidapi-bsd.txt create mode 100644 license/SoftwareContentRegister.txt create mode 100644 src/hid_api/AUTHORS.txt create mode 100644 src/hid_api/LICENSE-bsd.txt create mode 100644 src/hid_api/LICENSE-gpl3.txt create mode 100644 src/hid_api/LICENSE-orig.txt create mode 100644 src/hid_api/LICENSE.txt create mode 100644 src/hid_api/ORIGIN.url create mode 100644 src/hid_api/hidapi/hidapi.h create mode 100644 src/hid_api/linux/hid.c create mode 100644 src/hid_api/mac/hid.c create mode 100644 src/hid_api/windows/hid.c create mode 100644 src/lpcusbsio.c diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..3f84702 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1 @@ +See the 'license' folder for SoftwareContentRegister.txt file and related license files. diff --git a/include/lpcusbsio.h b/include/lpcusbsio.h new file mode 100644 index 0000000..b1463fe --- /dev/null +++ b/include/lpcusbsio.h @@ -0,0 +1,794 @@ +/* + * Copyright 2014, 2021 NXP + * + * SPDX-License-Identifier: BSD-3-Clause + * + * NXP USBSIO Library to control SPI, I2C and GPIO bus over USB + */ + +#ifndef __LPCUSBSIO_H +#define __LPCUSBSIO_H + +#include +#include "lpcusbsio_protocol.h" + +#if defined(LPCUSBSIO_EXPORTS) +#define LPCUSBSIO_API __declspec(dllexport) +#elif defined(LPCUSBSIO_IMPORTS) +#define LPCUSBSIO_API __declspec(dllimport) +#else +#define LPCUSBSIO_API +#endif + +#if defined(_MSC_VER) +/* Windows version requires the setupapi library */ +#pragma comment(lib,"setupapi.lib") +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/** @defgroup LPCUSBSIO_API LPC USB serial I/O (LPCUSBSIO) API interface + * API description
+ * The LPCUSBSIO APIs can be divided into two broad sets. The first set consists of + * five control APIs and the second set consists of two data transferring APIs. On error + * most APIs return an LPCUSBSIO_ERR_T code. Application code can call LPCUSBSIO_Error() routine + * to get user presentable uni-code string corresponding to the last error. + *
+ * The current version of LPCUSBSIO allows communicating with I2C, SPI slave devices and GPIO. + * + * @{ + */ + +/** NXP USB-IF vendor ID. */ +#define LPCUSBSIO_VID 0x1FC9 +/** USB-IF product ID for LPCUSBSIO devices. */ +#define LPCUSBSIO_PID 0x0090 +#define MCULINKSIO_PID 0x0143 + +/** Read time-out value in milliseconds used by the library. If a response is not received + * + */ +#define LPCUSBSIO_READ_TMO 500 + +/** I2C_IO_OPTIONS Options to I2C_DeviceWrite & I2C_DeviceRead routines +* @{ +*/ +/** Generate start condition before transmitting */ +#define I2C_TRANSFER_OPTIONS_START_BIT 0x0001 + +/** Generate stop condition at the end of transfer */ +#define I2C_TRANSFER_OPTIONS_STOP_BIT 0x0002 + +/** Continue transmitting data in bulk without caring about Ack or nAck from device if this bit is +* not set. If this bit is set then stop transmitting the data in the buffer when the device nAcks +*/ +#define I2C_TRANSFER_OPTIONS_BREAK_ON_NACK 0x0004 + +/** lpcusbsio-I2C generates an ACKs for every Byte read. Some I2C slaves require the I2C +master to generate a nACK for the last data Byte read. Setting this bit enables working with such +I2C slaves */ +#define I2C_TRANSFER_OPTIONS_NACK_LAST_BYTE 0x0008 + +/* Setting this bit would mean that the address field should be ignored. +* The address is either a part of the data or this is a special I2C +* frame that doesn't require an address. For example when transferring a +* frame greater than the USB_HID packet this option can be used. +*/ +#define I2C_TRANSFER_OPTIONS_NO_ADDRESS 0x00000040 + +/** @} */ + +/** I2C_FAST_TRANSFER_OPTIONS I2C master faster transfer options +* @{ +*/ + +/** Ignore NACK during data transfer. By default transfer is aborted. */ +#define I2C_FAST_XFER_OPTION_IGNORE_NACK 0x01 +/** ACK last Byte received. By default we NACK last Byte we receive per I2C specification. */ +#define I2C_FAST_XFER_OPTION_LAST_RX_ACK 0x02 + +/** +* @} +*/ + +/****************************************************************************** +* Type defines +******************************************************************************/ +/** @brief Handle type */ +typedef void *LPC_HANDLE; + +/** @brief Error types returned by LPCUSBSIO APIs */ +typedef enum LPCUSBSIO_ERR_t { + /** All API return positive number for success */ + LPCUSBSIO_OK = 0, + /** HID library error. */ + LPCUSBSIO_ERR_HID_LIB = -1, + /** Handle passed to the function is invalid. */ + LPCUSBSIO_ERR_BAD_HANDLE = -2, + /** Thread Synchronization error. */ + LPCUSBSIO_ERR_SYNCHRONIZATION = -3, + /** Memory Allocation error. */ + LPCUSBSIO_ERR_MEM_ALLOC = -4, + /** Mutex Creation error. */ + LPCUSBSIO_ERR_MUTEX_CREATE = -5, + + /* Errors from hardware I2C interface*/ + /** Fatal error occurred */ + LPCUSBSIO_ERR_FATAL = -0x11, + /** Transfer aborted due to NACK */ + LPCUSBSIO_ERR_I2C_NAK = -0x12, + /** Transfer aborted due to bus error */ + LPCUSBSIO_ERR_I2C_BUS = -0x13, + /** NAK received after SLA+W or SLA+R */ + LPCUSBSIO_ERR_I2C_SLAVE_NAK = -0x14, + /** I2C bus arbitration lost to other master */ + LPCUSBSIO_ERR_I2C_ARBLOST = -0x15, + + /* Errors from firmware's HID-SIO bridge module */ + /** Transaction timed out */ + LPCUSBSIO_ERR_TIMEOUT = -0x20, + /** Invalid HID_SIO Request or Request not supported in this version. */ + LPCUSBSIO_ERR_INVALID_CMD = -0x21, + /** Invalid parameters are provided for the given Request. */ + LPCUSBSIO_ERR_INVALID_PARAM = -0x22, + /** Partial transfer completed. */ + LPCUSBSIO_ERR_PARTIAL_DATA = -0x23, +} LPCUSBSIO_ERR_T; + +/** @brief I2C clock rates */ +typedef enum I2C_ClockRate_t { + I2C_CLOCK_STANDARD_MODE = 100000, /*!< 100kb/sec */ + I2C_CLOCK_FAST_MODE = 400000, /*!< 400kb/sec */ + I2C_CLOCK_FAST_MODE_PLUS = 1000000, /*!< 1000kb/sec */ +} I2C_CLOCKRATE_T; + +/** @brief I2C Port configuration information */ +typedef struct I2C_PortConfig_t { + I2C_CLOCKRATE_T ClockRate; /*!< I2C Clock speed */ + uint32_t Options; /*!< Configuration options */ +} I2C_PORTCONFIG_T; + +/** @brief I2C Fast transfer parameter structure */ +typedef struct I2CFastXferParam_t { + uint16_t txSz; /*!< Number of bytes in transmit array, + if 0 only receive transfer will be carried on */ + uint16_t rxSz; /*!< Number of bytes to received, + if 0 only transmission we be carried on */ + uint16_t options; /*!< Fast transfer options */ + uint16_t slaveAddr; /*!< 7-bit I2C Slave address */ + const uint8_t *txBuff; /*!< Pointer to array of bytes to be transmitted */ + uint8_t *rxBuff; /*!< Pointer memory where bytes received from I2C be stored */ +} I2C_FAST_XFER_T; + +typedef struct SPI_PortConfig_t { + uint32_t busSpeed; /*!< SPI bus speed */ + uint32_t Options; /*!< Configuration options */ +} SPI_PORTCONFIG_T; + +/** Macro to generate SPI device number from port and pin */ +#define LPCUSBSIO_GEN_SPI_DEVICE_NUM(port, pin) ((((uint8_t)(port) & 0x07) << 5) | ((pin) & 0x1F)) + +/** @brief SPI transfer parameter structure */ +typedef struct SPIXferParam_t { + uint16_t length; /*!< Number of bytes to transmit and receive */ + uint8_t options; /*!< Transfer options */ + uint8_t device; /*!< SPI slave device, use @ref LPCUSBSIO_GEN_SPI_DEVICE_NUM macro + to derive device number from a GPIO port and pin number */ + const uint8_t *txBuff; /*!< Pointer to array of bytes to be transmitted */ + uint8_t *rxBuff; /*!< Pointer memory where bytes received from SPI be stored */ +} SPI_XFER_T; + +/* SPI config option aliases */ +#define SPI_CONFIG_OPTION_DATA_SIZE_8 HID_SPI_CONFIG_OPTION_DATA_SIZE_8 +#define SPI_CONFIG_OPTION_DATA_SIZE_16 HID_SPI_CONFIG_OPTION_DATA_SIZE_16 +#define SPI_CONFIG_OPTION_POL_0 HID_SPI_CONFIG_OPTION_POL_0 +#define SPI_CONFIG_OPTION_POL_1 HID_SPI_CONFIG_OPTION_POL_1 +#define SPI_CONFIG_OPTION_PHA_0 HID_SPI_CONFIG_OPTION_PHA_0 +#define SPI_CONFIG_OPTION_PHA_1 HID_SPI_CONFIG_OPTION_PHA_1 +#define SPI_CONFIG_OPTION_PRE_DELAY(x) HID_SPI_CONFIG_OPTION_PRE_DELAY(x) +#define SPI_CONFIG_OPTION_POST_DELAY(x) HID_SPI_CONFIG_OPTION_POST_DELAY(x) + +/****************************************************************************** +* LPCUSBSIO functions +******************************************************************************/ + +/** @brief Get number LPCUSBSIO ports available on the enumerated controllers. + * + * This function gets the number of LPCUSBSIO ports that are available on the controllers. + * The number of ports available in each of these chips is different. + * + * @param vid : Vendor ID. + * @param pid : Product ID. + * + * @returns + * The number of ports available on the enumerated controllers. + * + */ +LPCUSBSIO_API int LPCUSBSIO_GetNumPorts(uint32_t vid, uint32_t pid); + +/** @brief Opens the indexed Serial IO port. +* +* This function opens the indexed port and provides a handle to it. Valid values for +* the index of port can be from 0 to the value obtained using LPCUSBSIO_GetNumPorts +* – 1). +* +* @param index : Index of the port to be opened. +* +* @returns +* This function returns a handle to LPCUSBSIO port object on +* success or NULL on failure. +*/ +LPCUSBSIO_API LPC_HANDLE LPCUSBSIO_Open(uint32_t index); + + +/** @brief Closes a LPC Serial IO port. +* +* Closes a Serial IO port and frees all resources that were used by it. +* +* @param hUsbSio : Handle of the LPSUSBSIO port. +* +* @returns +* This function returns LPCUSBSIO_OK on success and negative error code on failure. +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t LPCUSBSIO_Close(LPC_HANDLE hUsbSio); + +/** @brief Get version string of the LPCUSBSIO library. +* +* @param hUsbSio : A device handle returned from LPCUSBSIO_Open(). +* +* @returns +* This function returns a string containing the version of the library. +* If the device handle passed is not NULL then the firmware version of +* the connected device is appended to the string. +*/ +LPCUSBSIO_API const char *LPCUSBSIO_GetVersion(LPC_HANDLE hUsbSio); + +/** @brief Get a string describing the last error which occurred. +* +* @param hUsbSio : A device handle returned from LPCUSBSIO_Open(). +* +* @returns +* This function returns a string containing the last error +* which occurred or NULL if none has occurred. +* +*/ +LPCUSBSIO_API const wchar_t *LPCUSBSIO_Error(LPC_HANDLE hUsbSio); + +/** @brief Returns the number of I2C ports supported by Serial IO device. +* +* @param hUsbSio : A device handle returned from LPCUSBSIO_Open(). +* +* @returns +* This function returns the number of I2C ports on success and negative error code on failure. +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API uint32_t LPCUSBSIO_GetNumI2CPorts(LPC_HANDLE hUsbSio); + +/** @brief Returns the number of SPI ports supported by Serial IO device. +* +* @param hUsbSio : A device handle returned from LPCUSBSIO_Open(). +* +* @returns +* This function returns the number of SPI ports on success and negative error code on failure. +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API uint32_t LPCUSBSIO_GetNumSPIPorts(LPC_HANDLE hUsbSio); + +/** @brief Returns the number of GPIO ports supported by Serial IO device. +* +* @param hUsbSio : A device handle returned from LPCUSBSIO_Open(). +* +* @returns +* This function returns the number of GPIO ports on success and negative error code on failure. +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API uint32_t LPCUSBSIO_GetNumGPIOPorts(LPC_HANDLE hUsbSio); + +/** @brief Returns the max number of bytes supported for I2C/SPI transfers by the Serial IO device. +* +* @param hUsbSio : A device handle returned from LPCUSBSIO_Open(). +* +* @returns +* This function returns the max data transfer size on success and negative error code on failure. +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API uint32_t LPCUSBSIO_GetMaxDataSize(LPC_HANDLE hUsbSio); + +/** @brief Returns the last error seen by the Library. +* +* @returns +* This function returns the last error seen by the library. +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t LPCUSBSIO_GetLastError(void); + +/****************************************************************************** +* I2C functions +******************************************************************************/ + +/** @brief Initialize a I2C port. + * + * This function initializes the I2C port and the communication parameters associated + * with it. + * + * @param hUsbSio : Handle of the LPSUSBSIO port. + * @param config : Pointer to I2C_PORTCONFIG_T structure. Members of + * I2C_PORTCONFIG_T structure contains the values for I2C + * master clock and Options + * @param portNum : I2C port number. + * + * @returns + * This function returns a handle to I2C port object on success or NULL on failure. + * Use LPCUSBSIO_Error() function to get last error. + */ +LPCUSBSIO_API LPC_HANDLE I2C_Open(LPC_HANDLE hUsbSio, I2C_PORTCONFIG_T *config, uint8_t portNum); + +/** @brief Closes a I2C port. + * + * Deinitializes I2C port and frees all resources that were used by it. + * + * @param hI2C : Handle of the I2C port. + * + * @returns + * This function returns LPCUSBSIO_OK on success and negative error code on failure. + * Check @ref LPCUSBSIO_ERR_T for more details on error code. + * + */ +LPCUSBSIO_API int32_t I2C_Close(LPC_HANDLE hI2C); + +/** @brief Reset I2C Controller. + * + * @param hI2C : A device handle returned from I2C_Open(). + * + * @returns + * This function returns LPCUSBSIO_OK on success and negative error code on failure. + * Check @ref LPCUSBSIO_ERR_T for more details on error code. + * + */ +LPCUSBSIO_API int32_t I2C_Reset(LPC_HANDLE hI2C); + + +/** @brief Read from an addressed I2C slave. + * + * This function reads the specified number of bytes from an addressed I2C slave. + * The @a options parameter effects the transfers. Some example transfers are shown below : + * - When I2C_TRANSFER_OPTIONS_START_BIT, I2C_TRANSFER_OPTIONS_STOP_BIT and + * I2C_TRANSFER_OPTIONS_NACK_LAST_BYTE are set. + * + * S Addr Rd [A] [rxBuff0] A [rxBuff1] A ...[rxBuffN] NA P + * + * - If I2C_TRANSFER_OPTIONS_NO_ADDRESS is also set. + * + * S [rxBuff0] A [rxBuff1] A ...[rxBuffN] NA P + * + * - if I2C_TRANSFER_OPTIONS_NACK_LAST_BYTE is not set + * + * S Addr Rd [A] [rxBuff0] A [rxBuff1] A ...[rxBuffN] A P + * + * - If I2C_TRANSFER_OPTIONS_STOP_BIT is not set. + * + * S Addr Rd [A] [rxBuff0] A [rxBuff1] A ...[rxBuffN] NA + * + * @param hI2C : Handle of the I2C port. + * @param deviceAddress : Address of the I2C slave. This is a 7bit value and + * it should not contain the data direction bit, i.e. the decimal + * value passed should be always less than 128 + * @param buffer : Pointer to the buffer where the read data is to be stored + * @param sizeToTransfer: Number of bytes to be read + * @param options: This parameter specifies data transfer options. Check HID_I2C_TRANSFER_OPTIONS_ macros. + * @returns + * This function returns number of bytes read on success and negative error code on failure. + * Check @ref LPCUSBSIO_ERR_T for more details on error code. + */ +LPCUSBSIO_API int32_t I2C_DeviceRead(LPC_HANDLE hI2C, + uint8_t deviceAddress, + uint8_t *buffer, + uint16_t sizeToTransfer, + uint8_t options); + +/** @brief Writes to the addressed I2C slave. + * + * This function writes the specified number of bytes to an addressed I2C slave. + * The @a options parameter effects the transfers. Some example transfers are shown below : + * - When I2C_TRANSFER_OPTIONS_START_BIT, I2C_TRANSFER_OPTIONS_STOP_BIT and + * I2C_TRANSFER_OPTIONS_BREAK_ON_NACK are set. + * + * S Addr Wr[A] txBuff0[A] txBuff1[A] ... txBuffN[A] P + * + * - If I2C_TRANSFER_OPTIONS_NO_ADDRESS is also set. + * + * S txBuff0[A ] ... txBuffN[A] P + * + * - if I2C_TRANSFER_OPTIONS_BREAK_ON_NACK is not set + * + * S Addr Wr[A] txBuff0[A or NA] ... txBuffN[A or NA] P + * + * - If I2C_TRANSFER_OPTIONS_STOP_BIT is not set. + * + * S Addr Wr[A] txBuff0[A] txBuff1[A] ... txBuffN[A] + * + * @param hI2C : Handle of the I2C port. + * @param deviceAddress : Address of the I2C slave. This is a 7bit value and + * it should not contain the data direction bit, i.e. the decimal + * value passed should be always less than 128 + * @param buffer : Pointer to the buffer where the data to be written is stored + * @param sizeToTransfer: Number of bytes to be written + * @param options : This parameter specifies data transfer options. Check HID_I2C_TRANSFER_OPTIONS_ macros. + * @returns + * This function returns number of bytes written on success and negative error code on failure. + * Check @ref LPCUSBSIO_ERR_T for more details on error code. + */ +LPCUSBSIO_API int32_t I2C_DeviceWrite(LPC_HANDLE hI2C, + uint8_t deviceAddress, + uint8_t *buffer, + uint16_t sizeToTransfer, + uint8_t options); + +/**@brief Transmit and Receive data in I2C master mode + * + * The parameter @a xfer should have its member @a slaveAddr initialized + * to the 7 - Bit slave address to which the master will do the xfer, Bit0 + * to bit6 should have the address and Bit8 is ignored.During the transfer + * no code(like event handler) must change the content of the memory + * pointed to by @a xfer.The member of @a xfer, @a txBuff and @a txSz be + * initialized to the memory from which the I2C must pick the data to be + * transferred to slave and the number of bytes to send respectively, similarly + * @a rxBuff and @a rxSz must have pointer to memory where data received + * from slave be stored and the number of data to get from slave respectively. + * + * Following types of transfers are possible : + * - Write-only transfer : When @a rxSz member of @a xfer is set to 0. + * + * S Addr Wr[A] txBuff0[A] txBuff1[A] ... txBuffN[A] P + * + * - If I2C_FAST_XFER_OPTION_IGNORE_NACK is set in @a options member + * + * S Addr Wr[A] txBuff0[A or NA] ... txBuffN[A or NA] P + * + * - Read-only transfer : When @a txSz member of @a xfer is set to 0. + * + * S Addr Rd[A][rxBuff0] A[rxBuff1] A ...[rxBuffN] NA P + * + * - If I2C_FAST_XFER_OPTION_LAST_RX_ACK is set in @a options member + * + * S Addr Rd[A][rxBuff0] A[rxBuff1] A ...[rxBuffN] A P + * + * - Read-Write transfer : When @a rxSz and @ txSz members of @a xfer are non - zero. + * + * S Addr Wr[A] txBuff0[A] txBuff1[A] ... txBuffN[A]
+ * S Addr Rd[A][rxBuff0] A[rxBuff1] A ...[rxBuffN] NA P + * + * @param hI2C : Handle of the I2C port. + * @param xfer : Pointer to a I2C_FAST_XFER_T structure. + * @returns + * This function returns number of bytes read or written on success and negative error code on failure. + * Check @ref LPCUSBSIO_ERR_T for more details on error code. + */ +LPCUSBSIO_API int32_t I2C_FastXfer(LPC_HANDLE hI2C, I2C_FAST_XFER_T *xfer); + +/****************************************************************************** +* SPI functions +******************************************************************************/ + +/** @brief Initialize a SPI port. +* +* This function initializes the SPI port and the communication parameters associated +* with it. +* +* @param hUsbSio : Handle of the LPSUSBSIO port. +* @param config : Pointer to HID_SPI_PORTCONFIG_T structure. Members of +* HID_SPI_PORTCONFIG_T structure contains the values for SPI +* data size, clock polarity and phase +* @param portNum : SPI port number. +* +* @returns +* This function returns a handle to SPI port object on success or NULL on failure. +* Use LPCUSBSIO_Error() function to get last error. +*/ + +LPCUSBSIO_API LPC_HANDLE SPI_Open(LPC_HANDLE hUsbSio, HID_SPI_PORTCONFIG_T *config, uint8_t portNum); + +/** @brief Closes a SPI port. +* +* Deinitializes SPI port and frees all resources that were used by it. +* +* @param hSPI : Handle of the SPI port. +* +* @returns +* This function returns LPCUSBSIO_OK on success and negative error code on failure. +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t SPI_Close(LPC_HANDLE hSPI); + +/**@brief Transmit and Receive data in SPI master mode +* +* During the transfer no code(like event handler) must change the content of the memory +* pointed to by @a xfer.The member of @a xfer, @a txBuff and @a length be +* initialized to the memory from which the SPI must pick the data to be +* transferred to slave and the number of bytes to send respectively, similarly +* @a rxBuff and @a length must have pointer to memory where data received +* from slave be stored and the number of data to get from slave respectively. +* Since SPI is full duplex transmission transmit length and receive length are the same +* and represented by the member of @a xfer, @a length. +* +* @param hSPI : Handle of the SPI port. +* @param xfer : Pointer to a SPI_XFER_T structure. +* @returns +* This function returns number of bytes read on success and negative error code on failure. +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +*/ +LPCUSBSIO_API int32_t SPI_Transfer(LPC_HANDLE hSPI, SPI_XFER_T *xfer); + +/** @brief Reset SPI Controller. +* +* @param hSPI : A device handle returned from SPI_Open(). +* +* @returns +* This function returns LPCUSBSIO_OK on success and negative error code on failure. +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t SPI_Reset(LPC_HANDLE hSPI); + +/****************************************************************************** +* GPIO functions +******************************************************************************/ + +/** @brief Read a GPIO port. +* +* Reads the pin status of the GPIO port mentioned by @a port. Each port has 32 pins associated with it. +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param status : Pointer to GPIO port status, which is updated by the function. +* +* @returns +* This function returns negative error code on failure and returns the number of bytes +* read on success Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_ReadPort(LPC_HANDLE hUsbSio, uint8_t port, uint32_t* status); + +/** @brief Write to a GPIO port. +* +* Write the pin status of the GPIO port mentioned by @a port. Each port has 32 pins associated with it. +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param status : Pointer GPIO port status to be written. After writing into the GPIO port +* this value is updated with the read back from that port. +* +* @returns +* This function returns negative error code on failure and returns the number of bytes +* written on success. Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_WritePort(LPC_HANDLE hUsbSio, uint8_t port, uint32_t* status); + +/** @brief Set GPIO port bits. +* +* Sets the selected pins of the GPIO port mentioned by @a port. Each port has 32 pins associated with it. +* The pins selected are indicated by the corresponding high bits of @a pins +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pins : Indicates which pins need to be set high by setting the corresponding bit in this variable. +* +* @returns +* This function returns negative error code on failure and returns the number of bytes updated +* on success. Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_SetPort(LPC_HANDLE hUsbSio, uint8_t port, uint32_t pins); + +/** @brief Clear GPIO port bits. +* +* Clears the selected pins of the GPIO port mentioned by @a port. Each port has 32 pins associated with it. +* The pins selected are indicated by the corresponding high bits of @a pins +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pins : Indicates which pins need to be cleared by setting the corresponding bit in this variable. +* +* @returns +* This function returns negative error code on failure and returns the number of bytes +* updated on success. Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_ClearPort(LPC_HANDLE hUsbSio, uint8_t port, uint32_t pins); + +/** @brief Read GPIO port direction bits. +* +* Reads the direction status for all pins of the GPIO port mentioned by @a port. Each port has 32 pins associated with it. +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pPins : Pointer to GPIO port direction status, which is updated by the function. +* +* @returns +* This function returns negative error code on failure and returns the number of bytes +* read on success. Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_GetPortDir(LPC_HANDLE hUsbSio, uint8_t port, uint32_t* pPins); + +/** @brief Sets GPIO port pins direction to output. +* +* Sets the direction of selected pins as output for the GPIO port mentioned by @a port. Each port has 32 pins associated with it. +* The pins selected are indicated by the corresponding high bits of @a pins +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pins : Indicates which pins are output pins by setting the corresponding bit in this variable. +* +* @returns +* This function returns negative error code on failure and returns the number of bytes +* updated on success. Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_SetPortOutDir(LPC_HANDLE hUsbSio, uint8_t port, uint32_t pins); + +/** @brief Sets GPIO port pins direction to input. +* +* Sets the direction of selected pins as input for the GPIO port mentioned by @a port. Each port has 32 pins associated with it. +* The pins selected are indicated by the corresponding high bits of @a pins +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pins : Indicates which pins are input pins by setting the corresponding bit in this variable. +* +* @returns +* This function returns negative error code on failure and returns the number of bytes +* updated on success. Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_SetPortInDir(LPC_HANDLE hUsbSio, uint8_t port, uint32_t pins); + +/** @brief Sets a specific GPIO port pin value to high. +* +* Sets a specific pin indicated by @a pin to high value for the GPIO port mentioned by @a port. +* Each port has 32 pins associated with it. +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pin : The pin number which needs to be set (0 - 31). +* +* @returns +* This function returns negative error code on failure and returns the number of bytes +* updated on success. Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_SetPin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin); + +/** @brief Reads the state of a specific GPIO port pin. +* +* Read the state of a specific pin indicated by @a pin for the GPIO port mentioned by @a port. +* Each port has 32 pins associated with it. +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pin : The pin number which needs to be read (0 - 31). +* +* @returns +* This function returns negative error code on failure and returns the pin state (0 or 1) +* upon on success. Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_GetPin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin); + +/** @brief Clears a specific GPIO port pin. +* +* Clears a specific pin indicated by @a pin for the GPIO port mentioned by @a port. +* Each port has 32 pins associated with it. +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pin : The pin number which needs to be cleared (0 - 31). +* +* @returns +* This function returns negative error code on failure and returns the number of bytes +* updated on success. Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_ClearPin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin); + +/** @brief Toggles the state of a specific GPIO port pin. +* +* Toggles the state of a specific pin indicated by @a pin for the GPIO port mentioned by @a port. +* Each port has 32 pins associated with it. +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pin : The pin number which needs to be toggled (0 - 31). +* +* @returns +* This function returns negative error code on failure and returns zero on success +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_TogglePin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin); + +/** @brief Configures the IO mode for a specific GPIO port pin. +* +* Configures the IO mode of a specific pin indicated by @a pin for the GPIO port mentioned by @a port +* to the value mentioned by @a mode. +* Each port has 32 pins associated with it. +* +* @param hUsbSio: Handle to LPCUSBSIO port. +* @param port : GPIO port number. +* @param pin : The pin number which needs to be configured (0 - 31). +* @param mode : The 32 bit IO mode value that needs to updated. +* +* @returns +* This function returns negative error code on failure and returns zero on success +* Check @ref LPCUSBSIO_ERR_T for more details on error code. +* +*/ +LPCUSBSIO_API int32_t GPIO_ConfigIOPin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin, uint32_t mode); + + + +typedef void* HIDAPI_ENUM_HANDLE; +typedef void* HIDAPI_DEVICE_HANDLE; + +// our own type wrapping the HID_API device_info, members are size-sorted for optimal layout +typedef struct _HIDAPI_DEVICE_INFO +{ + char* path; + wchar_t* serial_number; + wchar_t* manufacturer_string; + wchar_t* product_string; + int32_t interface_number; + uint16_t vendor_id; + uint16_t product_id; + uint16_t release_number; + + // Not all plaforms are able to read this extended information during pure enumeration. + // To make sure the information is valid, set 'read_ex_info' parameter to 1 in HIDAPI_Enumerate. + struct _HIDAPI_DEVICE_INFO_EX + { + uint16_t is_valid; + uint16_t output_report_length; + uint16_t input_report_length; + uint16_t usage_page; + uint16_t usage; + } ex; +} HIDAPI_DEVICE_INFO_T; + +// strucutre representing a single enumeration session +typedef struct _HIDAPI_ENUM +{ + struct hid_device_info* head; + struct hid_device_info* pos; + struct _HIDAPI_ENUM* next_enum; + int32_t ex_info; +} HIDAPI_ENUM_T; + +LPCUSBSIO_API int32_t LPCUSBSIO_GetDeviceInfo(uint32_t index, HIDAPI_DEVICE_INFO_T* pInfo); +LPCUSBSIO_API int32_t HIDAPI_EnumerateNext(HIDAPI_ENUM_HANDLE hHidEnum, HIDAPI_DEVICE_INFO_T* pInfo); +LPCUSBSIO_API int32_t HIDAPI_EnumerateRewind(HIDAPI_ENUM_HANDLE hHidEnum); +LPCUSBSIO_API int32_t HIDAPI_EnumerateFree(HIDAPI_ENUM_HANDLE hHidEnum); +LPCUSBSIO_API HIDAPI_DEVICE_HANDLE HIDAPI_OpenDevice(char* pDevicePath); +LPCUSBSIO_API int32_t HIDAPI_CloseDevice(HIDAPI_DEVICE_HANDLE hDevice); +LPCUSBSIO_API int32_t HIDAPI_DeviceWrite(HIDAPI_DEVICE_HANDLE hDevice, const void* data, int32_t size, uint32_t timeout_ms); +LPCUSBSIO_API int32_t HIDAPI_DeviceRead(HIDAPI_DEVICE_HANDLE hDevice, void* data, int32_t size, uint32_t timeout_ms); + +/** + * @} + */ + +#ifdef __cplusplus +} +#endif + +#endif /*__LPCUSBSIO_H*/ diff --git a/include/lpcusbsio_protocol.h b/include/lpcusbsio_protocol.h new file mode 100644 index 0000000..114beed --- /dev/null +++ b/include/lpcusbsio_protocol.h @@ -0,0 +1,397 @@ +/* + * Copyright 2014, 2021 NXP + * + * SPDX-License-Identifier: BSD-3-Clause + * + * NXP USBSIO Library - protocol definitions + */ + +#ifndef __LPCUSBSIO_PROTOCOL_H_ +#define __LPCUSBSIO_PROTOCOL_H_ + +#include + +#ifdef __cplusplus +extern "C" +{ +#endif + +#pragma pack(1) + +#define HID_USAGE_PAGE_SERIAL_IO 0xEA + +/** @defgroup LPCUSBSIO_PROTOCOL LPCUSBSIO protocol definitions for SIO interfaces + * @ingroup LPCUSBSIO + * This package defines the LPCUSBSIO packet structure for SIO interface. + * Both the firmware and PC (host) libraries use this definitions to construct + * the SIO payloads. + * @{ + */ + +#define HID_SIO_PACKET_SZ 64 /*!< Packet size of each SIO command packet */ +#define HID_SIO_PACKET_HEADER_SZ 8 /*!< Size of the header in SIO command packet */ +#define HID_SIO_MAX_XFER_PARAM_SIZE 8 /*!< Maximum value among the sizes of HID_SPI_XFER_PARAMS_T, HID_I2C_XFER_PARAMS_T and HID_I2C_RW_PARAMS_T*/ +#define HID_SIO_PACKET_DATA_SZ (HID_SIO_PACKET_SZ - HID_SIO_PACKET_HEADER_SZ) /*!< Size of data in each SIO command packet */ +#define HID_SIO_CALC_PACKETS_COUNT(x) ((x)?(((x)+HID_SIO_PACKET_DATA_SZ-1) / HID_SIO_PACKET_DATA_SZ):1) /*!< Total packet count needed to transfer data size (x) */ +#define HID_SIO_CALC_TRANSFER_LEN(x) ((x) + (HID_SIO_CALC_PACKETS_COUNT(x) * HID_SIO_PACKET_HEADER_SZ)) /*!< Transfer size calculation for a data size (x) */ + + +/********************************************************************** + HID_I2C Requests + **********************************************************************/ +/** Request to abort and flush all pending requests + * Request Packet layout: + * No parameters + * Response Packet layout: + * No response data + * sesID field in header contains the I2C port number. + */ +#define HID_I2C_REQ_RESET 0x00 + +/** Request to initialize the I2C port. + * Request Packet layout: + * byte[0 - 3] : I2C bus speed + * byte[4 - 7] : Configuration options + * Response Packet layout: + * No response data + * sesID field in header contains the I2C port number. + */ +#define HID_I2C_REQ_INIT_PORT 0x01 + +/** Request to de-initialize the I2C port. + * Request Packet layout: + * No parameters + * Response Packet layout: + * No response data + * sesID field in header contains the I2C port number. + */ +#define HID_I2C_REQ_DEINIT_PORT 0x02 + +/** Request to write data to the I2C port. + * Request Packet layout: + * byte[0 - 1] : Length of the transfer. + * byte[2] : options. + * byte[3] : I2C slave address + * byte[4 - ..] : Write data. + * Response Packet layout: + * No response data + * sesID field in header contains the I2C port number. + */ +#define HID_I2C_REQ_DEVICE_WRITE 0x03 + +/** Request to read data from the I2C port. + * Request Packet layout: + * byte[0 - 1] : Length of the transfer. + * byte[2] : options. + * byte[3] : I2C slave address + * byte[4 - ..] : reserved. + * Response Packet layout: + * byte[0 - ..] : read data. + * sesID field in header contains the I2C port number. + */ +#define HID_I2C_REQ_DEVICE_READ 0x04 + +/** Request to write and then read data from the I2C port. + * Request Packet layout: + * byte[0 - 1] : Transmit Length. + * byte[2 - 3] : Receive Length. + * byte[4 - 5] : Transfer options + * byte[6 - 7] : I2C Slave address. + * byte[8 - ..] : Transmit data if any. + * Response Packet layout: + * byte[0 - ..] : Read Data. + * sesID field in header contains the I2C port number. + */ +#define HID_I2C_REQ_DEVICE_XFER 0x05 + +/** Last I2C specific request */ +#define HID_I2C_REQ_MAX 0x0F + +/********************************************************************** + HID_SPI Requests +**********************************************************************/ +/** Request to reset and abort the SPI controller. + * Request Packet layout: + * No parameters + * Response Packet layout: + * No response data + * sesID field in header contains the SPI port number. + */ +#define HID_SPI_REQ_RESET 0x10 /*!< Request to abort and flush all pending requests */ +/** Request to initialize SPI port. + * Request Packet layout: + * byte[0 - 3] : SPI clock speed + * byte[4 - 7] : Configuration options + * Response Packet layout: + * No response data + * sesID field in header contains the SPI port number. + */ +#define HID_SPI_REQ_INIT_PORT 0x11 /*!< Request to initialize the SPI port */ +/** Request to deinitializ SPI port. + * Request Packet layout: + * No parameters + * Response Packet layout: + * No response data + * sesID field in header contains the SPI port number. + */ +#define HID_SPI_REQ_DEINIT_PORT 0x12 /*!< Request to de-initialize the SPI port */ +/** Request to write read data from the SPI port. + * Request Packet layout: + * byte[0 - 1] : Length of the transfer. + * byte[2] : options. + * byte[3] : SPI device address + * byte[4 - ..] : Write data. + * Response Packet layout: + * byte[0 - ..] : Read data. + * sesID field in header contains the SPI port number. + */ +#define HID_SPI_REQ_DEVICE_XFER 0x13 /*!< Request to write and then read data from the SPI port */ + +/** Last SPI specific request */ +#define HID_SPI_REQ_MAX 0x1F + +/********************************************************************** + HID_GPIO Requests +**********************************************************************/ + +/** Request to write GPIO port state. + * Request Packet layout: + * byte[0 - 3] : Bits/PINs to be set + * byte[4 - 7] : Bits/PINs to be cleared + * Response Packet layout: + * byte[0 - 3] : GPIO port PIN status + * sesID field in header contains the GPIO port number. + */ +#define HID_GPIO_REQ_PORT_VALUE 0x20 + +/** Request to set GPIO port pin direction state. + * Request Packet layout: + * byte[0 - 3] : Bits/PINs to be set as outputs + * byte[4 - 7] : Bits/PINs to be set as inputs + * Response Packet layout: + * byte[0 - 3] : GPIO port DIR status + * sesID field in header contains the GPIO port number. + */ +#define HID_GPIO_REQ_PORT_DIR 0x21 + +/** Request to set GPIO pin state. + * Request Packet layout: + * byte[0] : GPIO pin number + * byte[1 - 3] : Reserved + * Response Packet layout: + * No response data + * sesID field in header contains the GPIO port number. + */ +#define HID_GPIO_REQ_TOGGLE_PIN 0x23 + +/** Request to set IOCON state. + * Request Packet layout: + * byte[0 - 3] : PIN mode + * byte[4] : PIN number + * Response Packet layout: + * No response data + * sesID field in header contains the port number. + */ +#define HID_GPIO_REQ_IOCONFIG 0x24 + +/** Last GPIO specific request */ +#define HID_GPIO_REQ_MAX 0x2F + +/********************************************************************** + HID_SIO Requests +**********************************************************************/ + +/** Request to get LPCUSBSIO information. + * Request Packet layout: + * No parameters + * Response Packet layout: + * byte[0] : Number of I2C ports available on this instance + * byte[1] : Number of SPI ports available on this instance + * byte[2] : Number of GPIO ports available on this instance + * byte[3] : Reserved + * byte[4 - 5] : Firmware Minor version number + * byte[6 - 7] : Firmware Major version number + * byte[8 -...] : Firmware version string + */ +#define HID_SIO_REQ_DEV_INFO 0xF0 + +/** Last SIO specific request */ +#define HID_SIO_REQ_MAX 0xFF + +/** + * @brief HID to SIO bridge Request structure. + * Defines the structure of HID to SIO Request packet. This is same as + * HID OUT report. + */ +typedef struct __HIDSIO_OUT_REPORT { + uint16_t transfer_len; /*!< Total transfer length of the SIO request including the header */ + uint16_t packet_num; /*!< Number of the packet for the SIO transfer, starts from 0. */ + uint8_t packet_len; /*!< Length of the current HID_SIO packet including the header, this is <= 64 */ + uint8_t transId; /*!< HID_SIO transaction identifier. Rolls over after 255. */ + uint8_t sesId; /*!< HID_SIO session identifier. */ + uint8_t req; /*!< HID_SIO Request */ + uint8_t data[]; /*!< Data corresponding to the Request */ + +} HID_SIO_OUT_REPORT_T; + +/** HID_SIO responses. The response code below 0x10 should match with I2CM_STATUS codes in the firmware. */ +#define HID_SIO_RES_OK 0x00 /*!< Requested Request was executed successfully. */ +#define HID_SIO_RES_ERROR 0x01 /*!< Unknown error condition. */ +#define HID_SIO_RES_NAK 0x02 /*!< No device responded for the transmitted data. */ +#define HID_SIO_RES_BUS_ERROR 0x03 /*!< I2C bus error */ +#define HID_SIO_RES_SLAVE_NAK 0x04 /*!< NAK received after SLA+R */ +#define HID_SIO_RES_ARBLOST 0x05 /*!< Arbitration lost */ + +#define HID_SIO_RES_TIMEOUT 0x10 /*!< Transaction timed out. */ +#define HID_SIO_RES_INVALID_CMD 0x11 /*!< Invalid HID_SIO Request or Request not supported in this version. */ +#define HID_SIO_RES_INVALID_PARAM 0x12 /*!< Invalid parameters are provided for the given Request. */ +#define HID_SIO_RES_PARTIAL_DATA 0x13 /*!< Partial transfer completed. */ + +/** + * @brief HID to SIO bridge response structure. + * Defines the structure of HID to SIO Response packet. This is same as + * HID IN report. + */ +typedef struct __HIDSIO_IN_REPORT { + uint16_t transfer_len; /*!< Total transfer length of the SIO response including the header */ + uint16_t packet_num; /*!< Number of the packet for the SIO transfer, starts from 0. */ + uint8_t packet_len; /*!< Length of the current HID_SIO packet including the header, this is <= 64 */ + uint8_t transId; /*!< HID_SIO transaction identifier. */ + uint8_t sesId; /*!< HID_SIO session identifier. */ + uint8_t resp; /*!< HID_SIO response */ + uint8_t data[]; /*!< Data corresponding to the response */ + +} HID_SIO_IN_REPORT_T; + +/** + * @brief Port configuration information + */ +typedef struct __HIDI2C_PortConfig_t { + uint32_t busSpeed; /*!< I2C bus speed */ + uint32_t Options; /*!< Configuration options */ +} HID_I2C_PORTCONFIG_T; + +/** SPI_PORT_CFG_OPTIONS Port Configuration options + * @{ + */ +/** SPI Data Size is 8 Bits */ +#define HID_SPI_CONFIG_OPTION_DATA_SIZE_8 (0x0007) +/** SPI Data Size is 16 Bits */ +#define HID_SPI_CONFIG_OPTION_DATA_SIZE_16 (0x000F) +/** SPI Clock Default Polarity is Low */ +#define HID_SPI_CONFIG_OPTION_POL_0 ((uint32_t) 0 << 6) +/** SPI Clock Default Polarity is High */ +#define HID_SPI_CONFIG_OPTION_POL_1 ((uint32_t) 1 << 6) +/** SPI Data is captured on the first clock transition of the frame */ +#define HID_SPI_CONFIG_OPTION_PHA_0 ((uint32_t) 0 << 7) +/** SPI Data is captured on the second clock transition of the frame */ +#define HID_SPI_CONFIG_OPTION_PHA_1 ((uint32_t) 1 << 7) +/** SPI Pre Delay in micro seconds max of 255 */ +#define HID_SPI_CONFIG_OPTION_PRE_DELAY(x) ((uint32_t) (x) << 8) +/** SPI Post Delay in micro seconds max of 255 */ +#define HID_SPI_CONFIG_OPTION_POST_DELAY(x) ((uint32_t) (x) << 16) + + +/** @} */ + +/** +* @brief Port configuration information +*/ +typedef struct __HIDSPI_PortConfig_t { + uint32_t busSpeed; /*!< SPI bus speed */ + uint32_t Options; /*!< Configuration options */ +} HID_SPI_PORTCONFIG_T; + +/** I2C_IO_OPTIONS Options to I2C_DeviceWrite & I2C_DeviceRead routines + * @{ + */ +/** Generate start condition before transmitting */ +#define HID_I2C_TRANSFER_OPTIONS_START_BIT 0x0001 + +/** Generate stop condition at the end of transfer */ +#define HID_I2C_TRANSFER_OPTIONS_STOP_BIT 0x0002 + +/** Continue transmitting data in bulk without caring about Ack or nAck from device if this bit is + not set. If this bit is set then stop transmitting the data in the buffer when the device nAcks*/ +#define HID_I2C_TRANSFER_OPTIONS_BREAK_ON_NACK 0x0004 + +/** lpcusbsio-I2C generates an ACKs for every byte read. Some I2C slaves require the I2C + master to generate a nACK for the last data byte read. Setting this bit enables working with such + I2C slaves */ +#define HID_I2C_TRANSFER_OPTIONS_NACK_LAST_BYTE 0x0008 + +/* Setting this bit would mean that the address field should be ignored. + The address is either a part of the data or this is a special I2C + frame that doesn't require an address. For example when transferring a + frame greater than the USB_HID packet this option can be used. */ +#define HID_I2C_TRANSFER_OPTIONS_NO_ADDRESS 0x00000040 + +/** @} */ + +/** + * @brief HID to I2C bridge read and write transfer parameters structure. + * Defines the structure of HID to I2C read-write transfer parameters. + */ +typedef struct __HIDI2C_RW_PARAMS { + uint16_t length; /*!< Length of the transfer.*/ + uint8_t options; /*!< check @ref I2C_IO_OPTIONS. */ + uint8_t slaveAddr; /*!< I2C slave device address. */ + uint8_t data[]; /*!< Data corresponding to the response */ + +} HID_I2C_RW_PARAMS_T; + +/** I2C_FAST_XFER_OPTIONS I2C master faster transfer options + * @{ + */ + +/** Ignore NACK during data transfer. By default transfer is aborted. */ +#define I2C_FAST_XFER_OPTION_IGNORE_NACK 0x01 +/** ACK last byte received. By default we NACK last byte we receive per I2C spec. */ +#define I2C_FAST_XFER_OPTION_LAST_RX_ACK 0x02 + +/** + * @} + */ + +/** + * @brief HID to I2C bridge fast transfer parameters structure. + * Defines the parameters structure for HID_I2C_REQ_DEVICE_XFER command. + */ +typedef struct __HIDI2C_XFER_PARAMS { + uint16_t txLength; /*!< Length of the Tx transfer.*/ + uint16_t rxLength; /*!< Length of the Rx transfer. */ + uint16_t options; /*!< check @ref I2C_FAST_XFER_OPTIONS. */ + uint16_t slaveAddr; /*!< I2C slave device address. */ + uint8_t data[]; /*!< Data corresponding to the response */ + +} HID_I2C_XFER_PARAMS_T; + +/** Macro to convert SPI device to the GPIO port number */ +#define HID_SPI_DEVICE_TO_PORT(n) (((n) & 0xE0) >> 5) +/** Macro to convert SPI device to the GPIO pin number */ +#define HID_SPI_DEVICE_TO_PIN(n) ((n) & 0x1F) + +/** +* @brief HID to SPI bridge transfer parameters structure. +* Defines the parameters structure for HID_SPI_REQ_DEVICE_XFER command. +*/ +typedef struct __HIDSPI_XFER_PARAMS { + uint16_t length; /*!< Length of the SPI transfer.*/ + uint8_t options; /*!< SPI transfer options. Currently unused */ + uint8_t device; /*!< SPI slave device number i.e. SSELn. + Out of 8 bits the first 3 bits represent the port number and the last 5 bits represent the pin number */ + uint8_t data[]; /*!< Data corresponding to the response */ + +} HID_SPI_XFER_PARAMS_T; + +/** + * @} + */ + +#pragma pack() + +#ifdef __cplusplus +} +#endif + +#endif /* __LPCUSBSIO_PROTOCOL_H_ */ diff --git a/license/BSD-3-clause.txt b/license/BSD-3-clause.txt new file mode 100644 index 0000000..4b87ed4 --- /dev/null +++ b/license/BSD-3-clause.txt @@ -0,0 +1,11 @@ +Copyright 2021-2022 NXP + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/license/LICENSE-hidapi-bsd.txt b/license/LICENSE-hidapi-bsd.txt new file mode 100644 index 0000000..9af15fb --- /dev/null +++ b/license/LICENSE-hidapi-bsd.txt @@ -0,0 +1,26 @@ +Copyright (c) 2010, Alan Ott, Signal 11 Software +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of Signal 11 Software nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/license/SoftwareContentRegister.txt b/license/SoftwareContentRegister.txt new file mode 100644 index 0000000..8c5466e --- /dev/null +++ b/license/SoftwareContentRegister.txt @@ -0,0 +1,58 @@ +Release Name: NXP USBSIO Library +================================ + +USBSIO Library redistributables Version: 2.x + Author: NXP + License: BSD-3-Clause + Content register: this file + Format: binary library and accompanying header files + Location: bin/*, include/* + + +USBSIO Library source code Version: 2.x + Author: NXP + License: BSD-3-Clause + Content register: this file + Format: source code + Location: src/* + + +USBSIO Library test code Version: n/a + Author: NXP + License: BSD-3-Clause + Content register: this file + Format: source code + Location: test/* + + +USBSIO Library Python wrapper Version: 2.x +and Python test code Author: NXP + License: BSD-3-Clause + Content register: this file + Format: source code + Location: python/* + + +HIDAPI Library Version: n/a +cross-platform USB/HID communication Authors: Alan Ott +library for Linux, Mac, Windows Ludovic Rousseau + others as in https://github.com/signal11/hidapi/blob/master/AUTHORS.txt + Multiple license: license chosen BSD-3-Clause, + https://github.com/signal11/hidapi/blob/master/LICENSE-bsd.txt + Original location: https://github.com/signal11/hidapi + Format: modified source code + Location: src/hid_api/* + + +HIDAPI Library Version: 0.11.2 and later +new forked version Authors: Alan Ott + Ludovic Rousseau + others as in https://github.com/signal11/hidapi/blob/master/AUTHORS.txt + libusb/hidapi Team + For a comprehensive list of contributions, see the commit list at github: + https://github.com/libusb/hidapi/graphs/contributors + Multiple license: license chosen BSD-3-Clause, + https://github.com/libusb/hidapi/blob/master/LICENSE-bsd.txt + Original https://github.com/libusb/hidapi + Format: modified source code + Location: src/hid_api/* diff --git a/src/hid_api/AUTHORS.txt b/src/hid_api/AUTHORS.txt new file mode 100644 index 0000000..0d7d765 --- /dev/null +++ b/src/hid_api/AUTHORS.txt @@ -0,0 +1,19 @@ + +HIDAPI Authors: + +Alan Ott : + Original Author and Maintainer + Linux, Windows, and Mac implementations + +Ludovic Rousseau : + Formatting for Doxygen documentation + Bug fixes + Correctness fixes + + +For a comprehensive list of contributions, see the commit list at github: + http://github.com/signal11/hidapi/commits/master + + +Michal Hanak + Modifications for use in libusbsio diff --git a/src/hid_api/LICENSE-bsd.txt b/src/hid_api/LICENSE-bsd.txt new file mode 100644 index 0000000..9af15fb --- /dev/null +++ b/src/hid_api/LICENSE-bsd.txt @@ -0,0 +1,26 @@ +Copyright (c) 2010, Alan Ott, Signal 11 Software +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of Signal 11 Software nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/src/hid_api/LICENSE-gpl3.txt b/src/hid_api/LICENSE-gpl3.txt new file mode 100644 index 0000000..818433e --- /dev/null +++ b/src/hid_api/LICENSE-gpl3.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/src/hid_api/LICENSE-orig.txt b/src/hid_api/LICENSE-orig.txt new file mode 100644 index 0000000..4baff19 --- /dev/null +++ b/src/hid_api/LICENSE-orig.txt @@ -0,0 +1,9 @@ + HIDAPI - Multi-Platform library for + communication with HID devices. + + Copyright 2009, Alan Ott, Signal 11 Software. + All Rights Reserved. + + This software may be used by anyone for any reason so + long as the copyright notice in the source files + remains intact. diff --git a/src/hid_api/LICENSE.txt b/src/hid_api/LICENSE.txt new file mode 100644 index 0000000..1a31ae0 --- /dev/null +++ b/src/hid_api/LICENSE.txt @@ -0,0 +1,13 @@ +HIDAPI can be used under one of three licenses. + +1. The GNU General Public License, version 3.0, in LICENSE-gpl3.txt +2. A BSD-Style License, in LICENSE-bsd.txt. +3. The more liberal original HIDAPI license. LICENSE-orig.txt + +The license chosen is at the discretion of the user of HIDAPI. For example: +1. An author of GPL software would likely use HIDAPI under the terms of the +GPL. + +2. An author of commercial closed-source software would likely use HIDAPI +under the terms of the BSD-style license or the original HIDAPI license. + diff --git a/src/hid_api/ORIGIN.url b/src/hid_api/ORIGIN.url new file mode 100644 index 0000000..39e845e --- /dev/null +++ b/src/hid_api/ORIGIN.url @@ -0,0 +1,2 @@ +[InternetShortcut] +URL=https://github.com/signal11/hidapi diff --git a/src/hid_api/hidapi/hidapi.h b/src/hid_api/hidapi/hidapi.h new file mode 100644 index 0000000..3bf287a --- /dev/null +++ b/src/hid_api/hidapi/hidapi.h @@ -0,0 +1,472 @@ +/******************************************************* + HIDAPI - Multi-Platform library for + communication with HID devices. + + Alan Ott + Signal 11 Software + + libusb/hidapi Team + + Copyright 2009,2022, All Rights Reserved. + + At the discretion of the user of this library, + this software may be licensed under the terms of the + GNU General Public License v3, a BSD-Style license, or the + original HIDAPI license as outlined in the LICENSE.txt, + LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt + files located at the root of the source distribution. + These files may also be found in the public source + code repository located at: + https://github.com/signal11/hidapi . + https://github.com/libusb/hidapi . +********************************************************/ + +/* + * Copyright 2021-2022 NXP + * Modified for use in NXP LIBUSBSIO Library + */ + +/** @file + * @defgroup API hidapi API + */ + +#ifndef HIDAPI_H__ +#define HIDAPI_H__ + +#include + +#ifdef _WIN32 + #define HID_API_EXPORT __declspec(dllexport) + #define HID_API_CALL +#else + #define HID_API_EXPORT /**< API export macro */ + #define HID_API_CALL /**< API call macro */ +#endif + +#define HID_API_EXPORT_CALL HID_API_EXPORT HID_API_CALL /**< API export and call macro*/ + +/** @brief Static/compile-time major version of the library. + + @ingroup API +*/ +#define HID_API_VERSION_MAJOR 0 +/** @brief Static/compile-time minor version of the library. + + @ingroup API +*/ +#define HID_API_VERSION_MINOR 11 +/** @brief Static/compile-time patch version of the library. + + @ingroup API +*/ +#define HID_API_VERSION_PATCH 2 + +/* Helper macros */ +#define HID_API_AS_STR_IMPL(x) #x +#define HID_API_AS_STR(x) HID_API_AS_STR_IMPL(x) +#define HID_API_TO_VERSION_STR(v1, v2, v3) HID_API_AS_STR(v1.v2.v3) + +/** @brief Static/compile-time string version of the library. + + @ingroup API +*/ +#define HID_API_VERSION_STR HID_API_TO_VERSION_STR(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH) + +#ifdef __cplusplus +extern "C" { +#endif + struct hid_api_version { + int major; + int minor; + int patch; + }; + + struct hid_device_; + typedef struct hid_device_ hid_device; /**< opaque hidapi structure */ + + /** hidapi info structure */ + struct hid_device_info { + /** Platform-specific device path */ + char *path; + /** Device Vendor ID */ + unsigned short vendor_id; + /** Device Product ID */ + unsigned short product_id; + /** Serial Number */ + wchar_t *serial_number; + /** Device Release Number in binary-coded decimal, + also known as Device Version Number */ + unsigned short release_number; + /** Manufacturer String */ + wchar_t *manufacturer_string; + /** Product string */ + wchar_t *product_string; + /** Usage Page for this Device/Interface + (Windows/Mac only). */ + unsigned short usage_page; + /** Usage for this Device/Interface + (Windows/Mac only).*/ + unsigned short usage; + /** The USB interface which this logical device + represents. Valid on both Linux implementations + in all cases, and valid on the Windows implementation + only if the device contains more than one interface. */ + int interface_number; + + /** Pointer to the next device */ + struct hid_device_info *next; + }; + + + /** @brief Initialize the HIDAPI library. + + This function initializes the HIDAPI library. Calling it is not + strictly necessary, as it will be called automatically by + hid_enumerate() and any of the hid_open_*() functions if it is + needed. This function should be called at the beginning of + execution however, if there is a chance of HIDAPI handles + being opened by different threads simultaneously. + + @ingroup API + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_init(void); + + /** @brief Finalize the HIDAPI library. + + This function frees all of the static data associated with + HIDAPI. It should be called at the end of execution to avoid + memory leaks. + + @ingroup API + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_exit(void); + + /** @brief Enumerate the HID Devices. + + This function returns a linked list of all the HID devices + attached to the system which match vendor_id and product_id. + If @p vendor_id is set to 0 then any vendor matches. + If @p product_id is set to 0 then any product matches. + If @p vendor_id and @p product_id are both set to 0, then + all HID devices will be returned. + + @ingroup API + @param vendor_id The Vendor ID (VID) of the types of device + to open. + @param product_id The Product ID (PID) of the types of + device to open. + + @returns + This function returns a pointer to a linked list of type + struct #hid_device, containing information about the HID devices + attached to the system, or NULL in the case of failure. Free + this linked list by calling hid_free_enumeration(). + */ + struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id); + + /** @brief Free an enumeration Linked List + + This function frees a linked list created by hid_enumerate(). + + @ingroup API + @param devs Pointer to a list of struct_device returned from + hid_enumerate(). + */ + void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs); + + /** @brief Open a HID device using a Vendor ID (VID), Product ID + (PID) and optionally a serial number. + + If @p serial_number is NULL, the first device with the + specified VID and PID is opened. + + @ingroup API + @param vendor_id The Vendor ID (VID) of the device to open. + @param product_id The Product ID (PID) of the device to open. + @param serial_number The Serial Number of the device to open + (Optionally NULL). + + @returns + This function returns a pointer to a #hid_device object on + success or NULL on failure. + */ + HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number); + + /** @brief Open a HID device by its path name. + + The path name be determined by calling hid_enumerate(), or a + platform-specific path name can be used (eg: /dev/hidraw0 on + Linux). + + @ingroup API + @param path The path name of the device to open + + @returns + This function returns a pointer to a #hid_device object on + success or NULL on failure. + */ + HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path); + + /** @brief Write an Output report to a HID device. + + The first byte of @p data[] must contain the Report ID. For + devices which only support a single report, this must be set + to 0x0. The remaining bytes contain the report data. Since + the Report ID is mandatory, calls to hid_write() will always + contain one more byte than the report contains. For example, + if a hid report is 16 bytes long, 17 bytes must be passed to + hid_write(), the Report ID (or 0x0, for devices with a + single report), followed by the report data (16 bytes). In + this example, the length passed in would be 17. + + hid_write() will send the data on the first OUT endpoint, if + one exists. If it does not, it will send the data through + the Control Endpoint (Endpoint 0). + + @ingroup API + @param device A device handle returned from hid_open(). + @param data The data to send, including the report number as + the first byte. + @param length The length in bytes of the data to send. + + @returns + This function returns the actual number of bytes written and + -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_write(hid_device *device, const unsigned char *data, size_t length); + int HID_API_EXPORT HID_API_CALL hid_write_timeout(hid_device* dev, const unsigned char* data, size_t length, int milliseconds); + + + /** @brief Read an Input report from a HID device with timeout. + + Input reports are returned + to the host through the INTERRUPT IN endpoint. The first byte will + contain the Report number if the device uses numbered reports. + + @ingroup API + @param device A device handle returned from hid_open(). + @param data A buffer to put the read data into. + @param length The number of bytes to read. For devices with + multiple reports, make sure to read an extra byte for + the report number. + @param milliseconds timeout in milliseconds or -1 for blocking wait. + + @returns + This function returns the actual number of bytes read and + -1 on error. If no packet was available to be read within + the timeout period, this function returns 0. + */ + int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds); + + /** @brief Read an Input report from a HID device. + + Input reports are returned + to the host through the INTERRUPT IN endpoint. The first byte will + contain the Report number if the device uses numbered reports. + + @ingroup API + @param device A device handle returned from hid_open(). + @param data A buffer to put the read data into. + @param length The number of bytes to read. For devices with + multiple reports, make sure to read an extra byte for + the report number. + + @returns + This function returns the actual number of bytes read and + -1 on error. If no packet was available to be read and + the handle is in non-blocking mode, this function returns 0. + */ + int HID_API_EXPORT HID_API_CALL hid_read(hid_device *device, unsigned char *data, size_t length); + + /** @brief Set the device handle to be non-blocking. + + In non-blocking mode calls to hid_read() will return + immediately with a value of 0 if there is no data to be + read. In blocking mode, hid_read() will wait (block) until + there is data to read before returning. + + Nonblocking can be turned on and off at any time. + + @ingroup API + @param device A device handle returned from hid_open(). + @param nonblock enable or not the nonblocking reads + - 1 to enable nonblocking + - 0 to disable nonblocking. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *device, int nonblock); + + /** @brief Send a Feature report to the device. + + Feature reports are sent over the Control endpoint as a + Set_Report transfer. The first byte of @p data[] must + contain the Report ID. For devices which only support a + single report, this must be set to 0x0. The remaining bytes + contain the report data. Since the Report ID is mandatory, + calls to hid_send_feature_report() will always contain one + more byte than the report contains. For example, if a hid + report is 16 bytes long, 17 bytes must be passed to + hid_send_feature_report(): the Report ID (or 0x0, for + devices which do not use numbered reports), followed by the + report data (16 bytes). In this example, the length passed + in would be 17. + + @ingroup API + @param device A device handle returned from hid_open(). + @param data The data to send, including the report number as + the first byte. + @param length The length in bytes of the data to send, including + the report number. + + @returns + This function returns the actual number of bytes written and + -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *device, const unsigned char *data, size_t length); + + /** @brief Get a feature report from a HID device. + + Set the first byte of @p data[] to the Report ID of the + report to be read. Make sure to allow space for this + extra byte in @p data[]. Upon return, the first byte will + still contain the Report ID, and the report data will + start in data[1]. + + @ingroup API + @param device A device handle returned from hid_open(). + @param data A buffer to put the read data into, including + the Report ID. Set the first byte of @p data[] to the + Report ID of the report to be read, or set it to zero + if your device does not use numbered reports. + @param length The number of bytes to read, including an + extra byte for the report ID. The buffer can be longer + than the actual report. + + @returns + This function returns the number of bytes read plus + one for the report ID (which is still in the first + byte), or -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *device, unsigned char *data, size_t length); + + /** @brief Close a HID device. + + @ingroup API + @param device A device handle returned from hid_open(). + */ + void HID_API_EXPORT HID_API_CALL hid_close(hid_device *device); + + /** @brief Get The Manufacturer String from a HID device. + + @ingroup API + @param device A device handle returned from hid_open(). + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *device, wchar_t *string, size_t maxlen); + + /** @brief Get The Product String from a HID device. + + @ingroup API + @param device A device handle returned from hid_open(). + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_product_string(hid_device *device, wchar_t *string, size_t maxlen); + + /** @brief Get The Serial Number String from a HID device. + + @ingroup API + @param device A device handle returned from hid_open(). + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *device, wchar_t *string, size_t maxlen); + + /** @brief Get a string from a HID device, based on its string index. + + @ingroup API + @param device A device handle returned from hid_open(). + @param string_index The index of the string to get. + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *device, int string_index, wchar_t *string, size_t maxlen); + + /** @brief Get a string describing the last error which occurred. + + @ingroup API + @param device A device handle returned from hid_open(). + + @returns + This function returns a string containing the last error + which occurred or NULL if none has occurred. + */ + HID_API_EXPORT const wchar_t* HID_API_CALL hid_error(hid_device *device); + + + /** @brief Get in/out report lengths + + @ingroup API + @param device A device handle returned from hid_open(). + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT hid_get_report_lengths(hid_device* device, unsigned short* output_report_length, unsigned short* input_report_length); + + /** @brief Get usage page parsed from report descriptor + + @ingroup API + @param device A device handle returned from hid_open(). + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT hid_get_usage(hid_device* device, unsigned short* usage_page, unsigned short* usage); + + /** @brief Get a runtime version of the library. + + @ingroup API + + @returns + Pointer to statically allocated struct, that contains version. + */ + HID_API_EXPORT const struct hid_api_version* HID_API_CALL hid_version(void); + + + /** @brief Get a runtime version string of the library. + + @ingroup API + + @returns + Pointer to statically allocated string, that contains version string. + */ + HID_API_EXPORT const char* HID_API_CALL hid_version_str(void); + +#ifdef __cplusplus +} +#endif + +#endif + diff --git a/src/hid_api/linux/hid.c b/src/hid_api/linux/hid.c new file mode 100644 index 0000000..910da3f --- /dev/null +++ b/src/hid_api/linux/hid.c @@ -0,0 +1,1009 @@ +/******************************************************* + HIDAPI - Multi-Platform library for + communication with HID devices. + + Alan Ott + Signal 11 Software + + 8/22/2009 + Linux Version - 6/2/2009 + + Copyright 2009, All Rights Reserved. + + At the discretion of the user of this library, + this software may be licensed under the terms of the + GNU General Public License v3, a BSD-Style license, or the + original HIDAPI license as outlined in the LICENSE.txt, + LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt + files located at the root of the source distribution. + These files may also be found in the public source + code repository located at: + http://github.com/signal11/hidapi . +********************************************************/ + +/* + * Copyright 2014, 2021 NXP + * Modified for use in NXP LIBUSBSIO Library + */ + +/* C */ +#include +#include +#include +#include +#include + +/* Unix */ +#include +#include +#include +#include +#include +#include +#include + +/* Linux */ +#include +#include +#include +#include + +#include "hidapi.h" + +/* Definitions from linux/hidraw.h. Since these are new, some distros + may not have header files which contain them. */ +#ifndef HIDIOCSFEATURE +#define HIDIOCSFEATURE(len) _IOC(_IOC_WRITE | _IOC_READ, 'H', 0x06, len) +#endif +#ifndef HIDIOCGFEATURE +#define HIDIOCGFEATURE(len) _IOC(_IOC_WRITE | _IOC_READ, 'H', 0x07, len) +#endif + +/* Definitions from linux/include/linux/usb.h. Timeouts, in milliseconds, + used for sending receiving control messages. */ +#define USB_CTRL_GET_TIMEOUT 5000 +#define USB_CTRL_SET_TIMEOUT 5000 + +/* USB HID device property names */ +const char *device_string_names[] = { + "manufacturer", "product", "serial", +}; + +/* Symbolic names for the properties above */ +enum device_string_id +{ + DEVICE_STRING_MANUFACTURER, + DEVICE_STRING_PRODUCT, + DEVICE_STRING_SERIAL, + + DEVICE_STRING_COUNT, +}; + +struct hid_device_ +{ + int device_handle; + int blocking; + int uses_numbered_reports; /* non-zero if numbered records are used */ + unsigned short input_report_length; /* maximum size of an input report */ + unsigned short output_report_length; /* maximum size of an output report */ + unsigned int usage_page; /* unlike Windows/Mac, we are only able to find out usage_page after opening the device */ +}; + +static __u32 kernel_version = 0; + +static __u32 detect_kernel_version(void) +{ + struct utsname name; + int major, minor, release; + int ret; + + uname(&name); + ret = sscanf(name.release, "%d.%d.%d", &major, &minor, &release); + if (ret == 3) + { + return KERNEL_VERSION(major, minor, release); + } + + ret = sscanf(name.release, "%d.%d", &major, &minor); + if (ret == 2) + { + return KERNEL_VERSION(major, minor, 0); + } + + printf("Couldn't determine kernel version from version string \"%s\"\n", name.release); + return 0; +} + +static hid_device *new_hid_device(void) +{ + hid_device *dev = calloc(1, sizeof(hid_device)); + dev->device_handle = -1; + dev->blocking = 1; + dev->uses_numbered_reports = 0; + dev->input_report_length = 0; + dev->output_report_length = 0; + dev->usage_page = 0; + + return dev; +} + +/* The caller must free the returned string with free(). */ +static wchar_t *utf8_to_wchar_t(const char *utf8) +{ + wchar_t *ret = NULL; + + if (utf8) + { + size_t wlen = mbstowcs(NULL, utf8, 0); + if ((size_t)-1 == wlen) + { + return wcsdup(L""); + } + ret = calloc(wlen + 1, sizeof(wchar_t)); + mbstowcs(ret, utf8, wlen + 1); + ret[wlen] = 0x0000; + } + + return ret; +} + +/* Get an attribute value from a udev_device and return it as a whar_t + string. The returned string must be freed with free() when done.*/ +static wchar_t *copy_udev_string(struct udev_device *dev, const char *udev_name) +{ + return utf8_to_wchar_t(udev_device_get_sysattr_value(dev, udev_name)); +} + +/* + * The caller is responsible for free()ing the (newly-allocated) character + * strings pointed to by serial_number_utf8 and product_name_utf8 after use. + */ +static int parse_uevent_info(const char *uevent, + int *bus_type, + unsigned short *vendor_id, + unsigned short *product_id, + char **serial_number_utf8, + char **product_name_utf8) +{ + char *tmp = strdup(uevent); + char *saveptr = NULL; + char *line; + char *key; + char *value; + + int found_id = 0; + int found_serial = 0; + int found_name = 0; + + line = strtok_r(tmp, "\n", &saveptr); + while (line != NULL) + { + /* line: "KEY=value" */ + key = line; + value = strchr(line, '='); + if (!value) + { + goto next_line; + } + *value = '\0'; + value++; + + if (strcmp(key, "HID_ID") == 0) + { + /** + * type vendor product + * HID_ID=0003:000005AC:00008242 + **/ + int ret = sscanf(value, "%x:%hx:%hx", bus_type, vendor_id, product_id); + if (ret == 3) + { + found_id = 1; + } + } + else if (strcmp(key, "HID_NAME") == 0) + { + /* The caller has to free the product name */ + *product_name_utf8 = strdup(value); + found_name = 1; + } + else if (strcmp(key, "HID_UNIQ") == 0) + { + /* The caller has to free the serial number */ + *serial_number_utf8 = strdup(value); + found_serial = 1; + } + + next_line: + line = strtok_r(NULL, "\n", &saveptr); + } + + free(tmp); + return (found_id && found_name && found_serial); +} + +static int get_device_string(hid_device *dev, enum device_string_id key, wchar_t *string, size_t maxlen) +{ + struct udev *udev; + struct udev_device *udev_dev, *parent, *hid_dev; + struct stat s; + int ret = -1; + char *serial_number_utf8 = NULL; + char *product_name_utf8 = NULL; + + /* Create the udev object */ + udev = udev_new(); + if (!udev) + { + printf("Can't create udev\n"); + return -1; + } + + /* Get the dev_t (major/minor numbers) from the file handle. */ + fstat(dev->device_handle, &s); + /* Open a udev device from the dev_t. 'c' means character device. */ + udev_dev = udev_device_new_from_devnum(udev, 'c', s.st_rdev); + if (udev_dev) + { + hid_dev = udev_device_get_parent_with_subsystem_devtype(udev_dev, "hid", NULL); + if (hid_dev) + { + unsigned short dev_vid; + unsigned short dev_pid; + int bus_type; + size_t retm; + + ret = parse_uevent_info(udev_device_get_sysattr_value(hid_dev, "uevent"), &bus_type, &dev_vid, &dev_pid, + &serial_number_utf8, &product_name_utf8); + + if (bus_type == BUS_BLUETOOTH) + { + switch (key) + { + case DEVICE_STRING_MANUFACTURER: + wcsncpy(string, L"", maxlen); + ret = 0; + break; + case DEVICE_STRING_PRODUCT: + retm = mbstowcs(string, product_name_utf8, maxlen); + ret = (retm == (size_t)-1) ? -1 : 0; + break; + case DEVICE_STRING_SERIAL: + retm = mbstowcs(string, serial_number_utf8, maxlen); + ret = (retm == (size_t)-1) ? -1 : 0; + break; + case DEVICE_STRING_COUNT: + default: + ret = -1; + break; + } + } + else + { + /* This is a USB device. Find its parent USB Device node. */ + parent = udev_device_get_parent_with_subsystem_devtype(udev_dev, "usb", "usb_device"); + if (parent) + { + const char *str; + const char *key_str = NULL; + + if (key >= 0 && key < DEVICE_STRING_COUNT) + { + key_str = device_string_names[key]; + } + else + { + ret = -1; + goto end; + } + + str = udev_device_get_sysattr_value(parent, key_str); + if (str) + { + /* Convert the string from UTF-8 to wchar_t */ + retm = mbstowcs(string, str, maxlen); + ret = (retm == (size_t)-1) ? -1 : 0; + goto end; + } + } + } + } + } + +end: + free(serial_number_utf8); + free(product_name_utf8); + + udev_device_unref(udev_dev); + /* parent and hid_dev don't need to be (and can't be) unref'd. + I'm not sure why, but they'll throw double-free() errors. */ + udev_unref(udev); + + return ret; +} + +void parse_report_descriptor(struct hid_device_ *dev, unsigned char *hid_desc, size_t hid_desc_len) +{ + /* report sizes in bits */ + int last_report_count = 0; + int last_report_size = 0; + int total_input_bits = 0; + int total_output_bits = 0; + + /* descriptor processing index */ + int i = 0; + + /* while parsing the report descriptor, we will set the following fields */ + dev->output_report_length = 0; /* total size of ouput report */ + dev->input_report_length = 0; /* total size of input report */ + dev->uses_numbered_reports = 0; /* wheather device uses numbered records */ + dev->usage_page = 0; /* the first usage_page seen */ + + while (i < hid_desc_len) + { + int data_len, key_size; + int key_valid = 0; + unsigned int value = 0; + unsigned char key = hid_desc[i]; + + /* Determine type of the item */ + if ((key & 0xf0) == 0xf0) + { + /* This is a Long Item. The next byte contains the length of the data section (value) for this key. + See the HID specification, version 1.11, section 6.2.2.3 */ + if ((i+1) < hid_desc_len) + data_len = hid_desc[i+1]; + else + data_len = 0; /* malformed report */ + key_size = 3; + + /* note that we leave key_valid 'false' because we are not interested in long items */ + } + else + { + /* This is a Short Item. The bottom two bits of the key contain the size code for the data section + (value) for this key. Refer to the HID specification, version 1.11, section 6.2.2.2 */ + int size_code = key & 0x3; + switch (size_code) + { + case 0: + case 1: + case 2: + data_len = size_code; + break; + case 3: + data_len = 4; + break; + default: + data_len = 0; + break; + } + key_size = 1; + + if((i+data_len) < hid_desc_len) + { + int b; + + /* little endian value follows */ + value = 0; + for(b=0; busage_page = value; + } + /* Report size in bits (data_len 1) */ + else if(key == 0x75) + { + last_report_size = value; + } + /* Report count (data_len 1 or 2) */ + else if(key == 0x95 || key == 0x96) + { + last_report_count = value; + } + /* Input record */ + else if(key == 0x81 || key == 0x82) + { + total_input_bits += last_report_size * last_report_count; + } + /* Output record */ + else if(key == 0x91 || key == 0x92) + { + total_output_bits += last_report_size * last_report_count; + } + /* A new Report ID flushes the reports collected so far */ + else if(key == 0x85) + { + dev->uses_numbered_reports = 1; + + /* keep track of maximum input report size */ + if(total_input_bits) + { + int total = (total_input_bits + 7) / 8; + if(total > dev->input_report_length) + dev->input_report_length = total; + } + + /* the same for output report */ + if(total_output_bits) + { + int total = (total_output_bits + 7) / 8; + if(total > dev->output_report_length) + dev->output_report_length = total; + } + + /* start measuring the next report lengths */ + total_input_bits = 0; + total_output_bits = 0; + } + } + + /* Skip over this key and it's associated data */ + i += data_len + key_size; + } + + /* FIXME: We do not add 1 to report sizes when 'uses_numbered_reports' is detected. This may be different from Windows; + they claim they do add the byte: https://docs.microsoft.com/en-us/windows-hardware/drivers/ddi/hidpi/ns-hidpi-_hidp_caps. + If needed, use the dev->uses_numbered_reports flag to add an extra byte when reading/writing the reports */ + + /* process the last pending input report size */ + if(total_input_bits) + { + int total = (total_input_bits + 7) / 8; + if(total > dev->input_report_length) + dev->input_report_length = total; + } + + /* the same for output report */ + if(total_output_bits) + { + int total = (total_output_bits + 7) / 8; + if(total > dev->output_report_length) + dev->output_report_length = total; + } + + /* general sanity check */ + if(dev->output_report_length > 0x1000) + dev->output_report_length = 0x1000; + if(dev->input_report_length > 0x1000) + dev->input_report_length = 0x1000; +} + +int HID_API_EXPORT hid_init(void) +{ + const char *locale; + + /* Set the locale if it's not set. */ + locale = setlocale(LC_CTYPE, NULL); + if (!locale) + setlocale(LC_CTYPE, ""); + + kernel_version = detect_kernel_version(); + + return 0; +} + +int HID_API_EXPORT hid_exit(void) +{ + /* Nothing to do for this in the Linux/hidraw implementation. */ + return 0; +} + +struct hid_device_info HID_API_EXPORT *hid_enumerate(unsigned short vendor_id, unsigned short product_id) +{ + struct udev *udev; + struct udev_enumerate *enumerate; + struct udev_list_entry *devices, *dev_list_entry; + + struct hid_device_info *root = NULL; /* return object */ + struct hid_device_info *cur_dev = NULL; + struct hid_device_info *prev_dev = NULL; /* previous device */ + + hid_init(); + + /* Create the udev object */ + udev = udev_new(); + if (!udev) + { + printf("Can't create udev\n"); + return NULL; + } + + /* Create a list of the devices in the 'hidraw' subsystem. */ + enumerate = udev_enumerate_new(udev); + udev_enumerate_add_match_subsystem(enumerate, "hidraw"); + udev_enumerate_scan_devices(enumerate); + devices = udev_enumerate_get_list_entry(enumerate); + /* For each item, see if it matches the vid/pid, and if so + create a udev_device record for it */ + udev_list_entry_foreach(dev_list_entry, devices) + { + const char *sysfs_path; + const char *dev_path; + const char *str; + struct udev_device *raw_dev; /* The device's hidraw udev node. */ + struct udev_device *hid_dev; /* The device's HID udev node. */ + struct udev_device *usb_dev; /* The device's USB udev node. */ + struct udev_device *intf_dev; /* The device's interface (in the USB sense). */ + unsigned short dev_vid; + unsigned short dev_pid; + char *serial_number_utf8 = NULL; + char *product_name_utf8 = NULL; + wchar_t *intf_str; + int bus_type; + int result; + + /* Get the filename of the /sys entry for the device + and create a udev_device object (dev) representing it */ + sysfs_path = udev_list_entry_get_name(dev_list_entry); + raw_dev = udev_device_new_from_syspath(udev, sysfs_path); + dev_path = udev_device_get_devnode(raw_dev); + + hid_dev = udev_device_get_parent_with_subsystem_devtype(raw_dev, "hid", NULL); + + if (!hid_dev) + { + /* Unable to find parent hid device. */ + goto next; + } + + result = parse_uevent_info(udev_device_get_sysattr_value(hid_dev, "uevent"), &bus_type, &dev_vid, &dev_pid, + &serial_number_utf8, &product_name_utf8); + + if (!result) + { + /* parse_uevent_info() failed for at least one field. */ + goto next; + } + + if (bus_type != BUS_USB && bus_type != BUS_BLUETOOTH) + { + /* We only know how to handle USB and BT devices. */ + goto next; + } + + /* Check the VID/PID against the arguments */ + if ((vendor_id == 0x0 || vendor_id == dev_vid) && (product_id == 0x0 || product_id == dev_pid)) + { + struct hid_device_info *tmp; + + /* VID/PID match. Create the record. */ + tmp = malloc(sizeof(struct hid_device_info)); + if (cur_dev) + { + cur_dev->next = tmp; + } + else + { + root = tmp; + } + prev_dev = cur_dev; + cur_dev = tmp; + + /* Fill out the record */ + cur_dev->next = NULL; + cur_dev->path = dev_path ? strdup(dev_path) : NULL; + + /* VID/PID */ + cur_dev->vendor_id = dev_vid; + cur_dev->product_id = dev_pid; + + /* Serial Number */ + cur_dev->serial_number = utf8_to_wchar_t(serial_number_utf8); + + /* Release Number */ + cur_dev->release_number = 0x0; + + /* Interface Number */ + cur_dev->interface_number = -1; + + switch (bus_type) + { + case BUS_USB: + /* The device pointed to by raw_dev contains information about + the hidraw device. In order to get information about the + USB device, get the parent device with the + subsystem/devtype pair of "usb"/"usb_device". This will + be several levels up the tree, but the function will find + it. */ + usb_dev = udev_device_get_parent_with_subsystem_devtype(raw_dev, "usb", "usb_device"); + + if (!usb_dev) + { + /* Free this device */ + free(cur_dev->serial_number); + free(cur_dev->path); + free(cur_dev); + + /* Take it off the device list. */ + if (prev_dev) + { + prev_dev->next = NULL; + cur_dev = prev_dev; + } + else + { + cur_dev = root = NULL; + } + + goto next; + } + + /* Manufacturer and Product strings */ + cur_dev->manufacturer_string = + copy_udev_string(usb_dev, device_string_names[DEVICE_STRING_MANUFACTURER]); + cur_dev->product_string = copy_udev_string(usb_dev, device_string_names[DEVICE_STRING_PRODUCT]); + + /* Release Number */ + str = udev_device_get_sysattr_value(usb_dev, "bcdDevice"); + cur_dev->release_number = (str) ? strtol(str, NULL, 16) : 0x0; + + /* Get a handle to the interface's udev node. */ + intf_dev = udev_device_get_parent_with_subsystem_devtype(raw_dev, "usb", "usb_interface"); + if (intf_dev) + { + str = udev_device_get_sysattr_value(intf_dev, "bInterfaceNumber"); + cur_dev->interface_number = (str) ? strtol(str, NULL, 16) : -1; + + /* use interface descriptor instead of product name if possible (same as on Windows) */ + intf_str = copy_udev_string(intf_dev, "interface"); + if(intf_str) { + if(cur_dev->product_string) + free(cur_dev->product_string); + cur_dev->product_string = intf_str; + } + } + + break; + + case BUS_BLUETOOTH: + /* Manufacturer and Product strings */ + cur_dev->manufacturer_string = wcsdup(L""); + cur_dev->product_string = utf8_to_wchar_t(product_name_utf8); + + break; + + default: + /* Unknown device type - this should never happen, as we + * check for USB and Bluetooth devices above */ + break; + } + } + + next: + free(serial_number_utf8); + free(product_name_utf8); + udev_device_unref(raw_dev); + /* hid_dev, usb_dev and intf_dev don't need to be (and can't be) + unref()d. It will cause a double-free() error. I'm not + sure why. */ + } + /* Free the enumerator and udev objects. */ + udev_enumerate_unref(enumerate); + udev_unref(udev); + + return root; +} + +void HID_API_EXPORT hid_free_enumeration(struct hid_device_info *devs) +{ + struct hid_device_info *d = devs; + while (d) + { + struct hid_device_info *next = d->next; + free(d->path); + free(d->serial_number); + free(d->manufacturer_string); + free(d->product_string); + free(d); + d = next; + } +} + +hid_device *hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number) +{ + struct hid_device_info *devs, *cur_dev; + const char *path_to_open = NULL; + hid_device *handle = NULL; + + devs = hid_enumerate(vendor_id, product_id); + cur_dev = devs; + while (cur_dev) + { + if (cur_dev->vendor_id == vendor_id && cur_dev->product_id == product_id) + { + if (serial_number && (wcslen(serial_number) > 0)) + { + if (wcscmp(serial_number, cur_dev->serial_number) == 0) + { + path_to_open = cur_dev->path; + break; + } + } + else + { + path_to_open = cur_dev->path; + break; + } + } + cur_dev = cur_dev->next; + } + + if (path_to_open) + { + /* Open the device */ + handle = hid_open_path(path_to_open); + } + + hid_free_enumeration(devs); + + return handle; +} + +hid_device *HID_API_EXPORT hid_open_path(const char *path) +{ + hid_device *dev = NULL; + + hid_init(); + + dev = new_hid_device(); + + /* OPEN HERE */ + dev->device_handle = open(path, O_RDWR); + + /* If we have a good handle, return it. */ + if (dev->device_handle > 0) + { + /* Get the report descriptor */ + int res, desc_size = 0; + struct hidraw_report_descriptor rpt_desc; + + memset(&rpt_desc, 0x0, sizeof(rpt_desc)); + + /* Get Report Descriptor Size */ + res = ioctl(dev->device_handle, HIDIOCGRDESCSIZE, &desc_size); + if (res < 0) + perror("HIDIOCGRDESCSIZE"); + + /* Get Report Descriptor */ + rpt_desc.size = desc_size; + res = ioctl(dev->device_handle, HIDIOCGRDESC, &rpt_desc); + if (res < 0) + { + perror("HIDIOCGRDESC"); + } + else + { + /* Parse report descriptor to get uses_numbered_reports, output_report_length, etc... */ + parse_report_descriptor(dev, rpt_desc.value, rpt_desc.size); + } + + return dev; + } + else + { + /* Unable to open any devices. */ + free(dev); + return NULL; + } +} + +int HID_API_EXPORT hid_write_timeout(hid_device *dev, const unsigned char *data, size_t length, int milliseconds) +{ + unsigned char* padded = NULL; + int bytes_written = 0; + + if (length <= 0) + return 0; + + if (length < (size_t)dev->output_report_length) + { + padded = calloc(1, dev->output_report_length); + + if(padded != NULL) + { + /* use buffer of report_length size padded with zeroes instead of original data */ + memcpy(padded, data, length); + length = (size_t)dev->output_report_length; + data = padded; + } + } + + /* + * Note: + * 1. Blocking Write for USB is not real blocking. There is a build-in timeout in Linux, which + * is defined by USB_CTRL_SET_TIMEOUT in linux/include/linux/usb.h + * 2. Do not use poll()/ppoll() for timeout control. POLLOUT wouldn't be triggered by HIDRAW. + */ + if (milliseconds >= 0) + { + while (milliseconds >= 0) + { + bytes_written = write(dev->device_handle, data, length); + milliseconds -= USB_CTRL_SET_TIMEOUT; + if ((bytes_written < 0) && (errno == ETIMEDOUT) && (milliseconds > 0)) + { + // timeout for current write, but still some time left. + continue; + } + else + { + break; + } + } + } + else + { + // Infinite blocking + while (1) + { + bytes_written = write(dev->device_handle, data, length); + if ((bytes_written < 0) && (errno == ETIMEDOUT)) + { + continue; + } + else + { + break; + } + } + } + + if(padded) + free(padded); + + return bytes_written; +} + +int HID_API_EXPORT hid_write(hid_device *dev, const unsigned char *data, size_t length) +{ + return hid_write_timeout(dev, data, length, (dev->blocking) ? -1 : 0); +} + +int HID_API_EXPORT hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds) +{ + int bytes_read; + + if (milliseconds >= 0) + { + /* Milliseconds is either 0 (non-blocking) or > 0 (contains + a valid timeout). In both cases we want to call poll() + and wait for data to arrive. Don't rely on non-blocking + operation (O_NONBLOCK) since some kernels don't seem to + properly report device disconnection through read() when + in non-blocking mode. */ + int ret; + struct pollfd fds; + + fds.fd = dev->device_handle; + fds.events = POLLIN; + fds.revents = 0; + ret = poll(&fds, 1, milliseconds); + if (ret == -1 || ret == 0) + { + /* Error or timeout */ + return ret; + } + else + { + /* Check for errors on the file descriptor. This will + indicate a device disconnection. */ + if (fds.revents & (POLLERR | POLLHUP | POLLNVAL)) + return -1; + } + } + + bytes_read = read(dev->device_handle, data, length); + if (bytes_read < 0 && (errno == EAGAIN || errno == EINPROGRESS)) + bytes_read = 0; + + if (bytes_read >= 0 && kernel_version != 0 && kernel_version < KERNEL_VERSION(2, 6, 34) && + dev->uses_numbered_reports) + { + /* Work around a kernel bug. Chop off the first byte. */ + memmove(data, data + 1, bytes_read); + bytes_read--; + } + + return bytes_read; +} + +int HID_API_EXPORT hid_read(hid_device *dev, unsigned char *data, size_t length) +{ + return hid_read_timeout(dev, data, length, (dev->blocking) ? -1 : 0); +} + +int HID_API_EXPORT hid_set_nonblocking(hid_device *dev, int nonblock) +{ + /* Do all non-blocking in userspace using poll(), since it looks + like there's a bug in the kernel in some versions where + read() will not return -1 on disconnection of the USB device */ + + dev->blocking = !nonblock; + return 0; /* Success */ +} + +int HID_API_EXPORT hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length) +{ + int res; + + res = ioctl(dev->device_handle, HIDIOCSFEATURE(length), data); + if (res < 0) + perror("ioctl (SFEATURE)"); + + return res; +} + +int HID_API_EXPORT hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length) +{ + int res; + + res = ioctl(dev->device_handle, HIDIOCGFEATURE(length), data); + if (res < 0) + perror("ioctl (GFEATURE)"); + + return res; +} + +void HID_API_EXPORT hid_close(hid_device *dev) +{ + if (!dev) + return; + close(dev->device_handle); + free(dev); +} + +int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + return get_device_string(dev, DEVICE_STRING_MANUFACTURER, string, maxlen); +} + +int HID_API_EXPORT_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + return get_device_string(dev, DEVICE_STRING_PRODUCT, string, maxlen); +} + +int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + return get_device_string(dev, DEVICE_STRING_SERIAL, string, maxlen); +} + +int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *dev, int string_index, wchar_t *string, size_t maxlen) +{ + return -1; +} + +HID_API_EXPORT const wchar_t *HID_API_CALL hid_error(hid_device *dev) +{ + return NULL; +} + +int HID_API_EXPORT hid_get_report_lengths(hid_device* device, unsigned short* output_report_length, unsigned short* input_report_length) +{ + if (output_report_length) + *output_report_length = device->output_report_length; + if (input_report_length) + *input_report_length = device->input_report_length; + return 0; +} + +int HID_API_EXPORT hid_get_usage(hid_device* device, unsigned short* usage_page, unsigned short* usage) +{ + if (usage_page) + *usage_page = device->usage_page; + if (usage) + *usage = 0; // TODO: device->usage; (does a single usage value even make sense?) + return 0; +} diff --git a/src/hid_api/mac/hid.c b/src/hid_api/mac/hid.c new file mode 100644 index 0000000..35892ec --- /dev/null +++ b/src/hid_api/mac/hid.c @@ -0,0 +1,1242 @@ +/******************************************************* + HIDAPI - Multi-Platform library for + communication with HID devices. + + Alan Ott + Signal 11 Software + + libusb/hidapi Team + + Copyright 2022, All Rights Reserved. + + At the discretion of the user of this library, + this software may be licensed under the terms of the + GNU General Public License v3, a BSD-Style license, or the + original HIDAPI license as outlined in the LICENSE.txt, + LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt + files located at the root of the source distribution. + These files may also be found in the public source + code repository located at: + https://github.com/libusb/hidapi . +********************************************************/ + +/* + * Modified for use in NXP LIBUSBSIO Library + * Copyright 2021-2022 NXP + */ + +/* See Apple Technical Note TN2187 for details on IOHidManager. */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "hidapi.h" + +/* As defined in AppKit.h, but we don't need the entire AppKit for a single constant. */ +extern const double NSAppKitVersionNumber; + +/* Barrier implementation because Mac OSX doesn't have pthread_barrier. + It also doesn't have clock_gettime(). So much for POSIX and SUSv2. + This implementation came from Brent Priddy and was posted on + StackOverflow. It is used with his permission. */ +typedef int pthread_barrierattr_t; +typedef struct pthread_barrier { + pthread_mutex_t mutex; + pthread_cond_t cond; + int count; + int trip_count; +} pthread_barrier_t; + +static int pthread_barrier_init(pthread_barrier_t *barrier, const pthread_barrierattr_t *attr, unsigned int count) +{ + (void) attr; + + if(count == 0) { + errno = EINVAL; + return -1; + } + + if(pthread_mutex_init(&barrier->mutex, 0) < 0) { + return -1; + } + if(pthread_cond_init(&barrier->cond, 0) < 0) { + pthread_mutex_destroy(&barrier->mutex); + return -1; + } + barrier->trip_count = count; + barrier->count = 0; + + return 0; +} + +static int pthread_barrier_destroy(pthread_barrier_t *barrier) +{ + pthread_cond_destroy(&barrier->cond); + pthread_mutex_destroy(&barrier->mutex); + return 0; +} + +static int pthread_barrier_wait(pthread_barrier_t *barrier) +{ + pthread_mutex_lock(&barrier->mutex); + ++(barrier->count); + if(barrier->count >= barrier->trip_count) + { + barrier->count = 0; + pthread_cond_broadcast(&barrier->cond); + pthread_mutex_unlock(&barrier->mutex); + return 1; + } + else + { + pthread_cond_wait(&barrier->cond, &(barrier->mutex)); + pthread_mutex_unlock(&barrier->mutex); + return 0; + } +} + +static int return_data(hid_device *dev, unsigned char *data, size_t length); + +/* Linked List of input reports received from the device. */ +struct input_report { + uint8_t *data; + size_t len; + struct input_report *next; +}; + +struct hid_device_ { + IOHIDDeviceRef device_handle; + int blocking; + int uses_numbered_reports; + int disconnected; + CFStringRef run_loop_mode; + CFRunLoopRef run_loop; + CFRunLoopSourceRef source; + uint8_t *input_report_buf; + CFIndex max_input_report_len; + CFIndex max_output_report_len; + struct input_report *input_reports; + + pthread_t thread; + pthread_mutex_t mutex; /* Protects input_reports */ + pthread_cond_t condition; + pthread_barrier_t barrier; /* Ensures correct startup sequence */ + pthread_barrier_t shutdown_barrier; /* Ensures correct shutdown sequence */ + int shutdown_thread; + + unsigned short usage; + unsigned short usage_page; +}; + +static hid_device *new_hid_device(void) +{ + hid_device *dev = (hid_device*) calloc(1, sizeof(hid_device)); + dev->device_handle = NULL; + dev->blocking = 1; + dev->uses_numbered_reports = 0; + dev->disconnected = 0; + dev->run_loop_mode = NULL; + dev->run_loop = NULL; + dev->source = NULL; + dev->input_report_buf = NULL; + dev->input_reports = NULL; + dev->shutdown_thread = 0; + + /* Thread objects */ + pthread_mutex_init(&dev->mutex, NULL); + pthread_cond_init(&dev->condition, NULL); + pthread_barrier_init(&dev->barrier, NULL, 2); + pthread_barrier_init(&dev->shutdown_barrier, NULL, 2); + + return dev; +} + +static void free_hid_device(hid_device *dev) +{ + if (!dev) + return; + + /* Delete any input reports still left over. */ + struct input_report *rpt = dev->input_reports; + while (rpt) { + struct input_report *next = rpt->next; + free(rpt->data); + free(rpt); + rpt = next; + } + + /* Free the string and the report buffer. The check for NULL + is necessary here as CFRelease() doesn't handle NULL like + free() and others do. */ + if (dev->run_loop_mode) + CFRelease(dev->run_loop_mode); + if (dev->source) + CFRelease(dev->source); + free(dev->input_report_buf); + + /* Clean up the thread objects */ + pthread_barrier_destroy(&dev->shutdown_barrier); + pthread_barrier_destroy(&dev->barrier); + pthread_cond_destroy(&dev->condition); + pthread_mutex_destroy(&dev->mutex); + + /* Free the structure itself. */ + free(dev); +} + +static struct hid_api_version api_version = { + .major = HID_API_VERSION_MAJOR, + .minor = HID_API_VERSION_MINOR, + .patch = HID_API_VERSION_PATCH +}; + +static IOHIDManagerRef hid_mgr = 0x0; +static int is_macos_10_10_or_greater = 0; + + +#if 0 +static void register_error(hid_device *dev, const char *op) +{ + +} +#endif + +static CFArrayRef get_array_property(IOHIDDeviceRef device, CFStringRef key) +{ + CFTypeRef ref = IOHIDDeviceGetProperty(device, key); + if (ref != NULL && CFGetTypeID(ref) == CFArrayGetTypeID()) { + return (CFArrayRef)ref; + } else { + return NULL; + } +} + +static int32_t get_int_property(IOHIDDeviceRef device, CFStringRef key) +{ + CFTypeRef ref; + int32_t value; + + ref = IOHIDDeviceGetProperty(device, key); + if (ref) { + if (CFGetTypeID(ref) == CFNumberGetTypeID()) { + CFNumberGetValue((CFNumberRef) ref, kCFNumberSInt32Type, &value); + return value; + } + } + return 0; +} + +static CFArrayRef get_usage_pairs(IOHIDDeviceRef device) +{ + return get_array_property(device, CFSTR(kIOHIDDeviceUsagePairsKey)); +} + +static unsigned short get_vendor_id(IOHIDDeviceRef device) +{ + return get_int_property(device, CFSTR(kIOHIDVendorIDKey)); +} + +static unsigned short get_product_id(IOHIDDeviceRef device) +{ + return get_int_property(device, CFSTR(kIOHIDProductIDKey)); +} + +static int32_t get_max_report_length(IOHIDDeviceRef device) +{ + return get_int_property(device, CFSTR(kIOHIDMaxInputReportSizeKey)); +} + +static int32_t get_max_out_report_length(IOHIDDeviceRef device) +{ + return get_int_property(device, CFSTR(kIOHIDMaxOutputReportSizeKey)); +} + +static int get_string_property(IOHIDDeviceRef device, CFStringRef prop, wchar_t *buf, size_t len) +{ + CFStringRef str; + + if (!len) + return 0; + + str = (CFStringRef) IOHIDDeviceGetProperty(device, prop); + + buf[0] = 0; + + if (str) { + CFIndex str_len = CFStringGetLength(str); + CFRange range; + CFIndex used_buf_len; + CFIndex chars_copied; + + len --; + + range.location = 0; + range.length = ((size_t) str_len > len)? len: (size_t) str_len; + chars_copied = CFStringGetBytes(str, + range, + kCFStringEncodingUTF32LE, + (char) '?', + FALSE, + (UInt8*)buf, + len * sizeof(wchar_t), + &used_buf_len); + + if (chars_copied <= 0) + buf[0] = 0; + else + buf[chars_copied] = 0; + + return 0; + } + else + return -1; + +} + +static int get_serial_number(IOHIDDeviceRef device, wchar_t *buf, size_t len) +{ + return get_string_property(device, CFSTR(kIOHIDSerialNumberKey), buf, len); +} + +static int get_manufacturer_string(IOHIDDeviceRef device, wchar_t *buf, size_t len) +{ + return get_string_property(device, CFSTR(kIOHIDManufacturerKey), buf, len); +} + +static int get_product_string(IOHIDDeviceRef device, wchar_t *buf, size_t len) +{ + return get_string_property(device, CFSTR(kIOHIDProductKey), buf, len); +} + + +/* Implementation of wcsdup() for Mac. */ +static wchar_t *dup_wcs(const wchar_t *s) +{ + size_t len = wcslen(s); + wchar_t *ret = (wchar_t*) malloc((len+1)*sizeof(wchar_t)); + wcscpy(ret, s); + + return ret; +} + +/* Initialize the IOHIDManager. Return 0 for success and -1 for failure. */ +static int init_hid_manager(void) +{ + /* Initialize all the HID Manager Objects */ + hid_mgr = IOHIDManagerCreate(kCFAllocatorDefault, kIOHIDOptionsTypeNone); + if (hid_mgr) { + IOHIDManagerSetDeviceMatching(hid_mgr, NULL); + IOHIDManagerScheduleWithRunLoop(hid_mgr, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode); + return 0; + } + + return -1; +} + +HID_API_EXPORT const struct hid_api_version* HID_API_CALL hid_version() +{ + return &api_version; +} + +HID_API_EXPORT const char* HID_API_CALL hid_version_str() +{ + return HID_API_VERSION_STR; +} + +/* Initialize the IOHIDManager if necessary. This is the public function, and + it is safe to call this function repeatedly. Return 0 for success and -1 + for failure. */ +int HID_API_EXPORT hid_init(void) +{ + if (!hid_mgr) { + is_macos_10_10_or_greater = (NSAppKitVersionNumber >= 1343); /* NSAppKitVersionNumber10_10 */ + return init_hid_manager(); + } + + /* Already initialized. */ + return 0; +} + +int HID_API_EXPORT hid_exit(void) +{ + if (hid_mgr) { + /* Close the HID manager. */ + IOHIDManagerClose(hid_mgr, kIOHIDOptionsTypeNone); + CFRelease(hid_mgr); + hid_mgr = NULL; + } + + return 0; +} + +static void process_pending_events(void) { + SInt32 res; + do { + res = CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.001, FALSE); + } while(res != kCFRunLoopRunFinished && res != kCFRunLoopRunTimedOut); +} + +static struct hid_device_info *create_device_info_with_usage(IOHIDDeviceRef dev, int32_t usage_page, int32_t usage) +{ + unsigned short dev_vid; + unsigned short dev_pid; + int BUF_LEN = 256; + wchar_t buf[BUF_LEN]; + + struct hid_device_info *cur_dev; + io_object_t iokit_dev; + kern_return_t res; + uint64_t entry_id = 0; + + if (dev == NULL) { + return NULL; + } + + cur_dev = (struct hid_device_info *)calloc(1, sizeof(struct hid_device_info)); + if (cur_dev == NULL) { + return NULL; + } + + dev_vid = get_vendor_id(dev); + dev_pid = get_product_id(dev); + + cur_dev->usage_page = usage_page; + cur_dev->usage = usage; + + /* Fill out the record */ + cur_dev->next = NULL; + + /* Fill in the path (as a unique ID of the service entry) */ + cur_dev->path = NULL; + iokit_dev = IOHIDDeviceGetService(dev); + if (iokit_dev != MACH_PORT_NULL) { + res = IORegistryEntryGetRegistryEntryID(iokit_dev, &entry_id); + } + else { + res = KERN_INVALID_ARGUMENT; + } + + if (res == KERN_SUCCESS) { + /* max value of entry_id(uint64_t) is 18446744073709551615 which is 20 characters long, + so for (max) "path" string 'DevSrvsID:18446744073709551615' we would need + 9+1+20+1=31 bytes byffer, but allocate 32 for simple alignment */ + cur_dev->path = calloc(1, 32); + if (cur_dev->path != NULL) { + sprintf(cur_dev->path, "DevSrvsID:%llu", entry_id); + } + } + + if (cur_dev->path == NULL) { + /* for whatever reason, trying to keep it a non-NULL string */ + cur_dev->path = strdup(""); + } + + /* Serial Number */ + get_serial_number(dev, buf, BUF_LEN); + cur_dev->serial_number = dup_wcs(buf); + + /* Manufacturer and Product strings */ + get_manufacturer_string(dev, buf, BUF_LEN); + cur_dev->manufacturer_string = dup_wcs(buf); + get_product_string(dev, buf, BUF_LEN); + cur_dev->product_string = dup_wcs(buf); + + /* VID/PID */ + cur_dev->vendor_id = dev_vid; + cur_dev->product_id = dev_pid; + + /* Release Number */ + cur_dev->release_number = get_int_property(dev, CFSTR(kIOHIDVersionNumberKey)); + + /* Interface Number */ + /* We can only retrieve the interface number for USB HID devices. + * IOKit always seems to return 0 when querying a standard USB device + * for its interface. */ + int is_usb_hid = get_int_property(dev, CFSTR(kUSBInterfaceClass)) == kUSBHIDClass; + if (is_usb_hid) { + /* Get the interface number */ + cur_dev->interface_number = get_int_property(dev, CFSTR(kUSBInterfaceNumber)); + } else { + cur_dev->interface_number = -1; + } + + return cur_dev; +} + +static struct hid_device_info *create_device_info(IOHIDDeviceRef device) +{ + const int32_t primary_usage_page = get_int_property(device, CFSTR(kIOHIDPrimaryUsagePageKey)); + const int32_t primary_usage = get_int_property(device, CFSTR(kIOHIDPrimaryUsageKey)); + + /* Primary should always be first, to match previous behavior. */ + struct hid_device_info *root = create_device_info_with_usage(device, primary_usage_page, primary_usage); + struct hid_device_info *cur = root; + + if (!root) + return NULL; + + CFArrayRef usage_pairs = get_usage_pairs(device); + + if (usage_pairs != NULL) { + struct hid_device_info *next = NULL; + for (CFIndex i = 0; i < CFArrayGetCount(usage_pairs); i++) { + CFTypeRef dict = CFArrayGetValueAtIndex(usage_pairs, i); + if (CFGetTypeID(dict) != CFDictionaryGetTypeID()) { + continue; + } + + CFTypeRef usage_page_ref, usage_ref; + int32_t usage_page, usage; + + if (!CFDictionaryGetValueIfPresent((CFDictionaryRef)dict, CFSTR(kIOHIDDeviceUsagePageKey), &usage_page_ref) || + !CFDictionaryGetValueIfPresent((CFDictionaryRef)dict, CFSTR(kIOHIDDeviceUsageKey), &usage_ref) || + CFGetTypeID(usage_page_ref) != CFNumberGetTypeID() || + CFGetTypeID(usage_ref) != CFNumberGetTypeID() || + !CFNumberGetValue((CFNumberRef)usage_page_ref, kCFNumberSInt32Type, &usage_page) || + !CFNumberGetValue((CFNumberRef)usage_ref, kCFNumberSInt32Type, &usage)) { + continue; + } + if (usage_page == primary_usage_page && usage == primary_usage) + continue; /* Already added. */ + + next = create_device_info_with_usage(device, usage_page, usage); + cur->next = next; + if (next != NULL) { + cur = next; + } + } + } + + return root; +} + +struct hid_device_info HID_API_EXPORT *hid_enumerate(unsigned short vendor_id, unsigned short product_id) +{ + struct hid_device_info *root = NULL; /* return object */ + struct hid_device_info *cur_dev = NULL; + CFIndex num_devices; + int i; + + /* Set up the HID Manager if it hasn't been done */ + if (hid_init() < 0) + return NULL; + + /* give the IOHIDManager a chance to update itself */ + process_pending_events(); + + /* Get a list of the Devices */ + CFMutableDictionaryRef matching = NULL; + if (vendor_id != 0 || product_id != 0) { + matching = CFDictionaryCreateMutable(kCFAllocatorDefault, kIOHIDOptionsTypeNone, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks); + + if (matching && vendor_id != 0) { + CFNumberRef v = CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, &vendor_id); + CFDictionarySetValue(matching, CFSTR(kIOHIDVendorIDKey), v); + CFRelease(v); + } + + if (matching && product_id != 0) { + CFNumberRef p = CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, &product_id); + CFDictionarySetValue(matching, CFSTR(kIOHIDProductIDKey), p); + CFRelease(p); + } + } + IOHIDManagerSetDeviceMatching(hid_mgr, matching); + if (matching != NULL) { + CFRelease(matching); + } + + CFSetRef device_set = IOHIDManagerCopyDevices(hid_mgr); + if (device_set == NULL) { + return NULL; + } + + /* Convert the list into a C array so we can iterate easily. */ + num_devices = CFSetGetCount(device_set); + IOHIDDeviceRef *device_array = (IOHIDDeviceRef*) calloc(num_devices, sizeof(IOHIDDeviceRef)); + CFSetGetValues(device_set, (const void **) device_array); + + /* Iterate over each device, making an entry for it. */ + for (i = 0; i < num_devices; i++) { + + IOHIDDeviceRef dev = device_array[i]; + if (!dev) { + continue; + } + + struct hid_device_info *tmp = create_device_info(dev); + if (tmp == NULL) { + continue; + } + + if (cur_dev) { + cur_dev->next = tmp; + } + else { + root = tmp; + } + cur_dev = tmp; + + /* move the pointer to the tail of returnd list */ + while (cur_dev->next != NULL) { + cur_dev = cur_dev->next; + } + } + + free(device_array); + CFRelease(device_set); + + return root; +} + +void HID_API_EXPORT hid_free_enumeration(struct hid_device_info *devs) +{ + /* This function is identical to the Linux version. Platform independent. */ + struct hid_device_info *d = devs; + while (d) { + struct hid_device_info *next = d->next; + free(d->path); + free(d->serial_number); + free(d->manufacturer_string); + free(d->product_string); + free(d); + d = next; + } +} + +hid_device * HID_API_EXPORT hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number) +{ + /* This function is identical to the Linux version. Platform independent. */ + struct hid_device_info *devs, *cur_dev; + const char *path_to_open = NULL; + hid_device * handle = NULL; + + devs = hid_enumerate(vendor_id, product_id); + cur_dev = devs; + while (cur_dev) { + if (cur_dev->vendor_id == vendor_id && + cur_dev->product_id == product_id) { + if (serial_number) { + if (wcscmp(serial_number, cur_dev->serial_number) == 0) { + path_to_open = cur_dev->path; + break; + } + } + else { + path_to_open = cur_dev->path; + break; + } + } + cur_dev = cur_dev->next; + } + + if (path_to_open) { + /* Open the device */ + handle = hid_open_path(path_to_open); + } + + hid_free_enumeration(devs); + + return handle; +} + +static void hid_device_removal_callback(void *context, IOReturn result, + void *sender) +{ + (void) result; + (void) sender; + + /* Stop the Run Loop for this device. */ + hid_device *d = (hid_device*) context; + + d->disconnected = 1; + CFRunLoopStop(d->run_loop); +} + +/* The Run Loop calls this function for each input report received. + This function puts the data into a linked list to be picked up by + hid_read(). */ +static void hid_report_callback(void *context, IOReturn result, void *sender, + IOHIDReportType report_type, uint32_t report_id, + uint8_t *report, CFIndex report_length) +{ + (void) result; + (void) sender; + (void) report_type; + (void) report_id; + + struct input_report *rpt; + hid_device *dev = (hid_device*) context; + + /* Make a new Input Report object */ + rpt = (struct input_report*) calloc(1, sizeof(struct input_report)); + rpt->data = (uint8_t*) calloc(1, report_length); + memcpy(rpt->data, report, report_length); + rpt->len = report_length; + rpt->next = NULL; + + /* Lock this section */ + pthread_mutex_lock(&dev->mutex); + + /* Attach the new report object to the end of the list. */ + if (dev->input_reports == NULL) { + /* The list is empty. Put it at the root. */ + dev->input_reports = rpt; + } + else { + /* Find the end of the list and attach. */ + struct input_report *cur = dev->input_reports; + int num_queued = 0; + while (cur->next != NULL) { + cur = cur->next; + num_queued++; + } + cur->next = rpt; + + /* Pop one off if we've reached 30 in the queue. This + way we don't grow forever if the user never reads + anything from the device. */ + if (num_queued > 30) { + return_data(dev, NULL, 0); + } + } + + /* Signal a waiting thread that there is data. */ + pthread_cond_signal(&dev->condition); + + /* Unlock */ + pthread_mutex_unlock(&dev->mutex); + +} + +/* This gets called when the read_thread's run loop gets signaled by + hid_close(), and serves to stop the read_thread's run loop. */ +static void perform_signal_callback(void *context) +{ + hid_device *dev = (hid_device*) context; + CFRunLoopStop(dev->run_loop); /*TODO: CFRunLoopGetCurrent()*/ +} + +static void *read_thread(void *param) +{ + hid_device *dev = (hid_device*) param; + SInt32 code; + + /* Move the device's run loop to this thread. */ + IOHIDDeviceScheduleWithRunLoop(dev->device_handle, CFRunLoopGetCurrent(), dev->run_loop_mode); + + /* Create the RunLoopSource which is used to signal the + event loop to stop when hid_close() is called. */ + CFRunLoopSourceContext ctx; + memset(&ctx, 0, sizeof(ctx)); + ctx.version = 0; + ctx.info = dev; + ctx.perform = &perform_signal_callback; + dev->source = CFRunLoopSourceCreate(kCFAllocatorDefault, 0/*order*/, &ctx); + CFRunLoopAddSource(CFRunLoopGetCurrent(), dev->source, dev->run_loop_mode); + + /* Store off the Run Loop so it can be stopped from hid_close() + and on device disconnection. */ + dev->run_loop = CFRunLoopGetCurrent(); + + /* Notify the main thread that the read thread is up and running. */ + pthread_barrier_wait(&dev->barrier); + + /* Run the Event Loop. CFRunLoopRunInMode() will dispatch HID input + reports into the hid_report_callback(). */ + while (!dev->shutdown_thread && !dev->disconnected) { + code = CFRunLoopRunInMode(dev->run_loop_mode, 1000/*sec*/, FALSE); + /* Return if the device has been disconnected */ + if (code == kCFRunLoopRunFinished) { + dev->disconnected = 1; + break; + } + + + /* Break if The Run Loop returns Finished or Stopped. */ + if (code != kCFRunLoopRunTimedOut && + code != kCFRunLoopRunHandledSource) { + /* There was some kind of error. Setting + shutdown seems to make sense, but + there may be something else more appropriate */ + dev->shutdown_thread = 1; + break; + } + } + + /* Now that the read thread is stopping, Wake any threads which are + waiting on data (in hid_read_timeout()). Do this under a mutex to + make sure that a thread which is about to go to sleep waiting on + the condition actually will go to sleep before the condition is + signaled. */ + pthread_mutex_lock(&dev->mutex); + pthread_cond_broadcast(&dev->condition); + pthread_mutex_unlock(&dev->mutex); + + /* Wait here until hid_close() is called and makes it past + the call to CFRunLoopWakeUp(). This thread still needs to + be valid when that function is called on the other thread. */ + pthread_barrier_wait(&dev->shutdown_barrier); + + return NULL; +} + +/* \p path must be one of: + - in format 'DevSrvsID:' (as returned by hid_enumerate); + - a valid path to an IOHIDDevice in the IOService plane (as returned by IORegistryEntryGetPath, + e.g.: "IOService:/AppleACPIPlatformExpert/PCI0@0/AppleACPIPCI/EHC1@1D,7/AppleUSBEHCI/PLAYSTATION(R)3 Controller@fd120000/IOUSBInterface@0/IOUSBHIDDriver"); + Second format is for compatibility with paths accepted by older versions of HIDAPI. +*/ +static io_registry_entry_t hid_open_service_registry_from_path(const char *path) +{ + if (path == NULL) + return MACH_PORT_NULL; + + /* Get the IORegistry entry for the given path */ + if (strncmp("DevSrvsID:", path, 10) == 0) { + char *endptr; + uint64_t entry_id = strtoull(path + 10, &endptr, 10); + if (*endptr == '\0') { + return IOServiceGetMatchingService(kIOMasterPortDefault, IORegistryEntryIDMatching(entry_id)); + } + } + else { + /* Fallback to older format of the path */ + return IORegistryEntryFromPath(kIOMasterPortDefault, path); + } + + return MACH_PORT_NULL; +} + +hid_device * HID_API_EXPORT hid_open_path(const char *path) +{ + hid_device *dev = NULL; + io_registry_entry_t entry = MACH_PORT_NULL; + IOReturn ret = kIOReturnInvalid; + + /* Set up the HID Manager if it hasn't been done */ + if (hid_init() < 0) + goto return_error; + + dev = new_hid_device(); + + /* Get the IORegistry entry for the given path */ + entry = hid_open_service_registry_from_path(path); + if (entry == MACH_PORT_NULL) { + /* Path wasn't valid (maybe device was removed?) */ + goto return_error; + } + + /* Create an IOHIDDevice for the entry */ + dev->device_handle = IOHIDDeviceCreate(kCFAllocatorDefault, entry); + if (dev->device_handle == NULL) { + /* Error creating the HID device */ + goto return_error; + } + + /* Open the IOHIDDevice */ + ret = IOHIDDeviceOpen(dev->device_handle, kIOHIDOptionsTypeSeizeDevice); + if (ret == kIOReturnSuccess) { + char str[32]; + + /* Create the buffers for receiving data */ + dev->max_input_report_len = (CFIndex) get_max_report_length(dev->device_handle); + dev->input_report_buf = (uint8_t*) calloc(dev->max_input_report_len, sizeof(uint8_t)); + + /* For information only */ + dev->max_output_report_len = (CFIndex)get_max_out_report_length(dev->device_handle); + dev->usage_page = get_int_property(dev->device_handle, CFSTR(kIOHIDPrimaryUsagePageKey)); + dev->usage = get_int_property(dev->device_handle, CFSTR(kIOHIDPrimaryUsageKey)); + + /* Create the Run Loop Mode for this device. + printing the reference seems to work. */ + sprintf(str, "HIDAPI_%p", (void*) dev->device_handle); + dev->run_loop_mode = + CFStringCreateWithCString(NULL, str, kCFStringEncodingASCII); + + /* Attach the device to a Run Loop */ + IOHIDDeviceRegisterInputReportCallback( + dev->device_handle, dev->input_report_buf, dev->max_input_report_len, + &hid_report_callback, dev); + IOHIDDeviceRegisterRemovalCallback(dev->device_handle, hid_device_removal_callback, dev); + + /* Start the read thread */ + pthread_create(&dev->thread, NULL, read_thread, dev); + + /* Wait here for the read thread to be initialized. */ + pthread_barrier_wait(&dev->barrier); + + IOObjectRelease(entry); + return dev; + } + else { + goto return_error; + } + +return_error: + if (dev->device_handle != NULL) + CFRelease(dev->device_handle); + + if (entry != MACH_PORT_NULL) + IOObjectRelease(entry); + + free_hid_device(dev); + return NULL; +} + +static int set_report(hid_device *dev, IOHIDReportType type, const unsigned char *data, size_t length) +{ + const unsigned char *data_to_send = data; + CFIndex length_to_send = length; + IOReturn res; + unsigned char report_id; + + if (!data || (length == 0)) { + return -1; + } + + report_id = data[0]; + + if (report_id == 0x0) { + /* Not using numbered Reports. + Don't send the report number. */ + data_to_send = data+1; + length_to_send = length-1; + } + + /* Avoid crash if the device has been unplugged. */ + if (dev->disconnected) { + return -1; + } + + res = IOHIDDeviceSetReport(dev->device_handle, + type, + report_id, + data_to_send, length_to_send); + + if (res == kIOReturnSuccess) { + return (int) length; + } + + return -1; +} + +static int get_report(hid_device *dev, IOHIDReportType type, unsigned char *data, size_t length) +{ + unsigned char *report = data; + CFIndex report_length = length; + IOReturn res = kIOReturnSuccess; + const unsigned char report_id = data[0]; + + if (report_id == 0x0) { + /* Not using numbered Reports. + Don't send the report number. */ + report = data+1; + report_length = length-1; + } + + /* Avoid crash if the device has been unplugged. */ + if (dev->disconnected) { + return -1; + } + + res = IOHIDDeviceGetReport(dev->device_handle, + type, + report_id, + report, &report_length); + + if (res == kIOReturnSuccess) { + if (report_id == 0x0) { /* 0 report number still present at the beginning */ + report_length++; + } + return (int) report_length; + } + + return -1; +} + +int HID_API_EXPORT hid_write_timeout(hid_device *dev, const unsigned char *data, size_t length, int milliseconds) +{ + /* TODO: timeout is not implemented */ + return set_report(dev, kIOHIDReportTypeOutput, data, length); +} + +int HID_API_EXPORT HID_API_CALL hid_write(hid_device *dev, const unsigned char *data, size_t length) +{ + return hid_write_timeout(dev, data, length, (dev->blocking) ? -1 : 0); +} + +/* Helper function, so that this isn't duplicated in hid_read(). */ +static int return_data(hid_device *dev, unsigned char *data, size_t length) +{ + /* Copy the data out of the linked list item (rpt) into the + return buffer (data), and delete the liked list item. */ + struct input_report *rpt = dev->input_reports; + size_t len = (length < rpt->len)? length: rpt->len; + memcpy(data, rpt->data, len); + dev->input_reports = rpt->next; + free(rpt->data); + free(rpt); + return (int) len; +} + +static int cond_wait(const hid_device *dev, pthread_cond_t *cond, pthread_mutex_t *mutex) +{ + while (!dev->input_reports) { + int res = pthread_cond_wait(cond, mutex); + if (res != 0) + return res; + + /* A res of 0 means we may have been signaled or it may + be a spurious wakeup. Check to see that there's actually + data in the queue before returning, and if not, go back + to sleep. See the pthread_cond_timedwait() man page for + details. */ + + if (dev->shutdown_thread || dev->disconnected) + return -1; + } + + return 0; +} + +static int cond_timedwait(const hid_device *dev, pthread_cond_t *cond, pthread_mutex_t *mutex, const struct timespec *abstime) +{ + while (!dev->input_reports) { + int res = pthread_cond_timedwait(cond, mutex, abstime); + if (res != 0) + return res; + + /* A res of 0 means we may have been signaled or it may + be a spurious wakeup. Check to see that there's actually + data in the queue before returning, and if not, go back + to sleep. See the pthread_cond_timedwait() man page for + details. */ + + if (dev->shutdown_thread || dev->disconnected) + return -1; + } + + return 0; + +} + +int HID_API_EXPORT hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds) +{ + int bytes_read = -1; + + /* Lock the access to the report list. */ + pthread_mutex_lock(&dev->mutex); + + /* There's an input report queued up. Return it. */ + if (dev->input_reports) { + /* Return the first one */ + bytes_read = return_data(dev, data, length); + goto ret; + } + + /* Return if the device has been disconnected. */ + if (dev->disconnected) { + bytes_read = -1; + goto ret; + } + + if (dev->shutdown_thread) { + /* This means the device has been closed (or there + has been an error. An error code of -1 should + be returned. */ + bytes_read = -1; + goto ret; + } + + /* There is no data. Go to sleep and wait for data. */ + + if (milliseconds == -1) { + /* Blocking */ + int res; + res = cond_wait(dev, &dev->condition, &dev->mutex); + if (res == 0) + bytes_read = return_data(dev, data, length); + else { + /* There was an error, or a device disconnection. */ + bytes_read = -1; + } + } + else if (milliseconds > 0) { + /* Non-blocking, but called with timeout. */ + int res; + struct timespec ts; + struct timeval tv; + gettimeofday(&tv, NULL); + TIMEVAL_TO_TIMESPEC(&tv, &ts); + ts.tv_sec += milliseconds / 1000; + ts.tv_nsec += (milliseconds % 1000) * 1000000; + if (ts.tv_nsec >= 1000000000L) { + ts.tv_sec++; + ts.tv_nsec -= 1000000000L; + } + + res = cond_timedwait(dev, &dev->condition, &dev->mutex, &ts); + if (res == 0) + bytes_read = return_data(dev, data, length); + else if (res == ETIMEDOUT) + bytes_read = 0; + else + bytes_read = -1; + } + else { + /* Purely non-blocking */ + bytes_read = 0; + } + +ret: + /* Unlock */ + pthread_mutex_unlock(&dev->mutex); + return bytes_read; +} + +int HID_API_EXPORT hid_read(hid_device *dev, unsigned char *data, size_t length) +{ + return hid_read_timeout(dev, data, length, (dev->blocking)? -1: 0); +} + +int HID_API_EXPORT hid_set_nonblocking(hid_device *dev, int nonblock) +{ + /* All Nonblocking operation is handled by the library. */ + dev->blocking = !nonblock; + + return 0; +} + +int HID_API_EXPORT hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length) +{ + return set_report(dev, kIOHIDReportTypeFeature, data, length); +} + +int HID_API_EXPORT hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length) +{ + return get_report(dev, kIOHIDReportTypeFeature, data, length); +} + +int HID_API_EXPORT HID_API_CALL hid_get_input_report(hid_device *dev, unsigned char *data, size_t length) +{ + return get_report(dev, kIOHIDReportTypeInput, data, length); +} + +void HID_API_EXPORT hid_close(hid_device *dev) +{ + if (!dev) + return; + + /* Disconnect the report callback before close. + See comment below. + */ + if (is_macos_10_10_or_greater || !dev->disconnected) { + IOHIDDeviceRegisterInputReportCallback( + dev->device_handle, dev->input_report_buf, dev->max_input_report_len, + NULL, dev); + IOHIDDeviceRegisterRemovalCallback(dev->device_handle, NULL, dev); + IOHIDDeviceUnscheduleFromRunLoop(dev->device_handle, dev->run_loop, dev->run_loop_mode); + IOHIDDeviceScheduleWithRunLoop(dev->device_handle, CFRunLoopGetMain(), kCFRunLoopDefaultMode); + } + + /* Cause read_thread() to stop. */ + dev->shutdown_thread = 1; + + /* Wake up the run thread's event loop so that the thread can exit. */ + CFRunLoopSourceSignal(dev->source); + CFRunLoopWakeUp(dev->run_loop); + + /* Notify the read thread that it can shut down now. */ + pthread_barrier_wait(&dev->shutdown_barrier); + + /* Wait for read_thread() to end. */ + pthread_join(dev->thread, NULL); + + /* Close the OS handle to the device, but only if it's not + been unplugged. If it's been unplugged, then calling + IOHIDDeviceClose() will crash. + + UPD: The crash part was true in/until some version of macOS. + Starting with macOS 10.15, there is an opposite effect in some environments: + crash happenes if IOHIDDeviceClose() is not called. + Not leaking a resource in all tested environments. + */ + if (is_macos_10_10_or_greater || !dev->disconnected) { + IOHIDDeviceClose(dev->device_handle, kIOHIDOptionsTypeSeizeDevice); + } + + /* Clear out the queue of received reports. */ + pthread_mutex_lock(&dev->mutex); + while (dev->input_reports) { + return_data(dev, NULL, 0); + } + pthread_mutex_unlock(&dev->mutex); + CFRelease(dev->device_handle); + + free_hid_device(dev); +} + +int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + return get_manufacturer_string(dev->device_handle, string, maxlen); +} + +int HID_API_EXPORT_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + return get_product_string(dev->device_handle, string, maxlen); +} + +int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + return get_serial_number(dev->device_handle, string, maxlen); +} + +int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *dev, int string_index, wchar_t *string, size_t maxlen) +{ + (void) dev; + (void) string_index; + (void) string; + (void) maxlen; + + /* TODO: */ + + return 0; +} + + +HID_API_EXPORT const wchar_t * HID_API_CALL hid_error(hid_device *dev) +{ + (void) dev; + /* TODO: */ + + return L"hid_error is not implemented yet"; +} + +int HID_API_EXPORT hid_get_report_lengths(hid_device* device, unsigned short* output_report_length, unsigned short* input_report_length) +{ + if (output_report_length) + *output_report_length = (unsigned short)device->max_output_report_len; + if (input_report_length) + *input_report_length = (unsigned short)device->max_input_report_len; + return 0; +} + +int HID_API_EXPORT hid_get_usage(hid_device* device, unsigned short* usage_page, unsigned short* usage) +{ + if (usage_page) + *usage_page = device->usage_page; + if (usage) + *usage = device->usage; + return 0; +} + diff --git a/src/hid_api/windows/hid.c b/src/hid_api/windows/hid.c new file mode 100644 index 0000000..4078ead --- /dev/null +++ b/src/hid_api/windows/hid.c @@ -0,0 +1,1002 @@ +/******************************************************* +HIDAPI - Multi-Platform library for +communication with HID devices. + +Alan Ott +Signal 11 Software + +8/22/2009 + +Copyright 2009, All Rights Reserved. + +At the discretion of the user of this library, +this software may be licensed under the terms of the +GNU Public License v3, a BSD-Style license, or the +original HIDAPI license as outlined in the LICENSE.txt, +LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt +files located at the root of the source distribution. +These files may also be found in the public source +code repository located at: +http://github.com/signal11/hidapi . +********************************************************/ + +/* + * Modified for use in NXP LIBUSBSIO Library + * Copyright 2021 NXP + */ + +#include + +#ifndef _NTDEF_ +#pragma warning(suppress : 28251) +typedef LONG NTSTATUS; +#endif + +#ifdef __MINGW32__ +#include +#include +#endif + +#ifdef __CYGWIN__ +#include +#define _wcsdup wcsdup +#endif + +/*#define HIDAPI_USE_DDK*/ + +#ifdef __cplusplus +extern "C" { +#endif +#include +#include +#ifdef HIDAPI_USE_DDK +#include +#endif + +/* Copied from inc/ddk/hidclass.h, part of the Windows DDK. */ +#define HID_OUT_CTL_CODE(id) CTL_CODE(FILE_DEVICE_KEYBOARD, (id), METHOD_OUT_DIRECT, FILE_ANY_ACCESS) +#define IOCTL_HID_GET_FEATURE HID_OUT_CTL_CODE(100) + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#include +#include +#include "hidapi.h" + +#ifdef _MSC_VER +/* Thanks Microsoft, but I know how to use strncpy(). */ +#pragma warning(disable : 4996) +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#define WSTR_LEN 512 + +#ifndef HIDAPI_USE_DDK +/* Since we're not building with the DDK, and the HID header +files aren't part of the SDK, we have to define all this +stuff here. In lookup_functions(), the function pointers +defined below are set. */ +#define HIDP_STATUS_SUCCESS 0x110000 + +typedef struct _HIDD_ATTRIBUTES +{ + ULONG Size; + USHORT VendorID; + USHORT ProductID; + USHORT VersionNumber; +} HIDD_ATTRIBUTES, *PHIDD_ATTRIBUTES; + +typedef USHORT USAGE; +typedef struct _HIDP_CAPS +{ + USAGE Usage; + USAGE UsagePage; + USHORT InputReportByteLength; + USHORT OutputReportByteLength; + USHORT FeatureReportByteLength; + USHORT Reserved[17]; + USHORT fields_not_used_by_hidapi[10]; +} HIDP_CAPS, *PHIDP_CAPS; +typedef void *PHIDP_PREPARSED_DATA; + +typedef BOOLEAN(__stdcall *HidD_GetAttributes_)(HANDLE device, PHIDD_ATTRIBUTES attrib); +typedef BOOLEAN(__stdcall *HidD_GetSerialNumberString_)(HANDLE device, PVOID buffer, ULONG buffer_len); +typedef BOOLEAN(__stdcall *HidD_GetManufacturerString_)(HANDLE handle, PVOID buffer, ULONG buffer_len); +typedef BOOLEAN(__stdcall *HidD_GetProductString_)(HANDLE handle, PVOID buffer, ULONG buffer_len); +typedef BOOLEAN(__stdcall *HidD_SetFeature_)(HANDLE handle, PVOID data, ULONG length); +typedef BOOLEAN(__stdcall *HidD_GetFeature_)(HANDLE handle, PVOID data, ULONG length); +typedef BOOLEAN(__stdcall *HidD_GetIndexedString_)(HANDLE handle, ULONG string_index, PVOID buffer, ULONG buffer_len); +typedef BOOLEAN(__stdcall *HidD_GetPreparsedData_)(HANDLE handle, PHIDP_PREPARSED_DATA *preparsed_data); +typedef BOOLEAN(__stdcall *HidD_FreePreparsedData_)(PHIDP_PREPARSED_DATA preparsed_data); +typedef NTSTATUS(__stdcall *HidP_GetCaps_)(PHIDP_PREPARSED_DATA preparsed_data, HIDP_CAPS *caps); + +static HidD_GetAttributes_ HidD_GetAttributes; +static HidD_GetSerialNumberString_ HidD_GetSerialNumberString; +static HidD_GetManufacturerString_ HidD_GetManufacturerString; +static HidD_GetProductString_ HidD_GetProductString; +static HidD_SetFeature_ HidD_SetFeature; +static HidD_GetFeature_ HidD_GetFeature; +static HidD_GetIndexedString_ HidD_GetIndexedString; +static HidD_GetPreparsedData_ HidD_GetPreparsedData; +static HidD_FreePreparsedData_ HidD_FreePreparsedData; +static HidP_GetCaps_ HidP_GetCaps; + +static HMODULE lib_handle = NULL; +static BOOLEAN initialized = FALSE; +#endif /* HIDAPI_USE_DDK */ + +struct hid_device_ +{ + HANDLE device_handle; + BOOL blocking; + USHORT output_report_length; + size_t input_report_length; + USAGE usage; + USAGE usage_page; + void *last_error_str; + DWORD last_error_num; + BOOL read_pending; + char *read_buf; + OVERLAPPED read_ol; + OVERLAPPED write_ol; +}; + +static hid_device *new_hid_device() +{ + hid_device *dev = (hid_device *)calloc(1, sizeof(hid_device)); + dev->device_handle = INVALID_HANDLE_VALUE; + dev->blocking = TRUE; + dev->output_report_length = 0; + dev->input_report_length = 0; + dev->usage_page = 0; + dev->usage = 0; + dev->last_error_str = NULL; + dev->last_error_num = 0; + dev->read_pending = FALSE; + dev->read_buf = NULL; + memset(&dev->read_ol, 0, sizeof(dev->read_ol)); + dev->read_ol.hEvent = CreateEvent(NULL, FALSE, FALSE /*inital state f=nonsignaled*/, NULL); + memset(&dev->write_ol, 0, sizeof(dev->write_ol)); + dev->write_ol.hEvent = CreateEvent(NULL, FALSE, FALSE /*inital state f=nonsignaled*/, NULL); + + return dev; +} + +static void free_hid_device(hid_device *dev) +{ + CloseHandle(dev->read_ol.hEvent); + CloseHandle(dev->write_ol.hEvent); + CloseHandle(dev->device_handle); + LocalFree(dev->last_error_str); + free(dev->read_buf); + free(dev); +} + +static void register_error(hid_device *device, const wchar_t *op) +{ + // WCHAR *ptr; + WCHAR *sysMsg, *msg; + DWORD err = GetLastError(); + + FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, + err, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPWSTR)&sysMsg, 0 /*sz*/, NULL); + + /* Get rid of the CR and LF that FormatMessage() sticks at the + end of the message. Thanks Microsoft! */ + /* ptr = sysMsg; + while (*ptr) + { + if (*ptr == '\r') + { + *ptr = 0x0000; + break; + } + ptr++; + } + */ + msg = (WCHAR *)LocalAlloc(LMEM_ZEROINIT, (wcslen((LPCWSTR)sysMsg) + wcslen((LPCWSTR)op) + 40) * sizeof(WCHAR)); + swprintf((wchar_t *)msg, (size_t)LocalSize(msg), L"%s failed with error %d: %s", op, err, sysMsg); + + /* Store the message off in the Device entry so that + the hid_error() function can pick it up. */ + LocalFree(device->last_error_str); + LocalFree(sysMsg); + device->last_error_str = msg; +} + +#ifndef HIDAPI_USE_DDK +static int lookup_functions() +{ + lib_handle = LoadLibraryA("hid.dll"); + if (lib_handle) + { +#define RESOLVE(x) \ + x = (x##_)GetProcAddress(lib_handle, #x); \ + if (!x) \ + return -1; + RESOLVE(HidD_GetAttributes); + RESOLVE(HidD_GetSerialNumberString); + RESOLVE(HidD_GetManufacturerString); + RESOLVE(HidD_GetProductString); + RESOLVE(HidD_SetFeature); + RESOLVE(HidD_GetFeature); + RESOLVE(HidD_GetIndexedString); + RESOLVE(HidD_GetPreparsedData); + RESOLVE(HidD_FreePreparsedData); + RESOLVE(HidP_GetCaps); +#undef RESOLVE + } + else + return -1; + + return 0; +} +#endif /* HIDAPI_USE_DDK */ + +static HANDLE open_device(const char *path, BOOL enumerate) +{ + HANDLE handle; + DWORD desired_access = (enumerate) ? 0 : (GENERIC_WRITE | GENERIC_READ); + DWORD share_mode = (enumerate) ? FILE_SHARE_READ | FILE_SHARE_WRITE : FILE_SHARE_READ; + + handle = CreateFileA(path, desired_access, share_mode, NULL, OPEN_EXISTING, + FILE_FLAG_OVERLAPPED, /*FILE_ATTRIBUTE_NORMAL,*/ + 0); + + return handle; +} + +int HID_API_EXPORT hid_init(void) +{ +#ifndef HIDAPI_USE_DDK + if (!initialized) + { + if (lookup_functions() < 0) + { + hid_exit(); + return -1; + } + initialized = TRUE; + } +#endif + return 0; +} + +int HID_API_EXPORT hid_exit(void) +{ +#ifndef HIDAPI_USE_DDK + if (lib_handle) + { + FreeLibrary(lib_handle); + } + lib_handle = NULL; + initialized = FALSE; +#endif + return 0; +} + +struct hid_device_info HID_API_EXPORT *HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id) +{ + BOOL res; + struct hid_device_info *root = NULL; /* return object */ + struct hid_device_info *cur_dev = NULL; + + /* Windows objects for interacting with the driver. */ + GUID InterfaceClassGuid = { 0x4d1e55b2, 0xf16f, 0x11cf, { 0x88, 0xcb, 0x00, 0x11, 0x11, 0x00, 0x00, 0x30 } }; + SP_DEVINFO_DATA devinfo_data; + SP_DEVICE_INTERFACE_DATA device_interface_data; + SP_DEVICE_INTERFACE_DETAIL_DATA_A *device_interface_detail_data = NULL; + HDEVINFO device_info_set = INVALID_HANDLE_VALUE; + int device_index = 0; + int i; + + if (hid_init() < 0) + return NULL; + + /* Initialize the Windows objects. */ + memset(&devinfo_data, 0x0, sizeof(devinfo_data)); + devinfo_data.cbSize = sizeof(SP_DEVINFO_DATA); + device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA); + + /* Get information for all the devices belonging to the HID class. */ + device_info_set = SetupDiGetClassDevsA(&InterfaceClassGuid, NULL, NULL, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE); + + /* Iterate over each device in the HID class, looking for the right one. */ + for (;;) + { + HANDLE write_handle = INVALID_HANDLE_VALUE; + DWORD required_size = 0; + HIDD_ATTRIBUTES attrib; + + res = SetupDiEnumDeviceInterfaces(device_info_set, NULL, &InterfaceClassGuid, device_index, + &device_interface_data); + + if (!res) + { + /* A return of FALSE from this function means that + there are no more devices. */ + break; + } + + /* Call with 0-sized detail size, and let the function + tell us how long the detail struct needs to be. The + size is put in &required_size. */ + res = SetupDiGetDeviceInterfaceDetailA(device_info_set, &device_interface_data, NULL, 0, &required_size, NULL); + + /* Allocate a long enough structure for device_interface_detail_data. */ + device_interface_detail_data = (SP_DEVICE_INTERFACE_DETAIL_DATA_A *)malloc(required_size); + device_interface_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_A); + + /* Get the detailed data for this device. The detail data gives us + the device path for this device, which is then passed into + CreateFile() to get a handle to the device. */ + res = SetupDiGetDeviceInterfaceDetailA(device_info_set, &device_interface_data, device_interface_detail_data, + required_size, NULL, NULL); + + if (!res) + { + /* register_error(dev, L"Unable to call SetupDiGetDeviceInterfaceDetail"); + Continue to the next device. */ + goto cont; + } + + /* Make sure this device is of Setup Class "HIDClass" and has a + driver bound to it. */ + for (i = 0;; i++) + { + char driver_name[256]; + + /* Populate devinfo_data. This function will return failure + when there are no more interfaces left. */ + res = SetupDiEnumDeviceInfo(device_info_set, i, &devinfo_data); + if (!res) + { + goto cont; + } + + res = SetupDiGetDeviceRegistryPropertyA(device_info_set, &devinfo_data, SPDRP_CLASS, NULL, + (PBYTE)driver_name, sizeof(driver_name), NULL); + if (!res) + { + goto cont; + } + + if (strcmp(driver_name, "HIDClass") == 0) + { + /* See if there's a driver bound. */ + res = SetupDiGetDeviceRegistryPropertyA(device_info_set, &devinfo_data, SPDRP_DRIVER, NULL, + (PBYTE)driver_name, sizeof(driver_name), NULL); + if (res) + { + break; + } + } + } + + // wprintf(L"HandleName: %s\n", device_interface_detail_data->DevicePath); + + /* Open a handle to the device */ + write_handle = open_device(device_interface_detail_data->DevicePath, TRUE); + + /* Check validity of write_handle. */ + if (write_handle == INVALID_HANDLE_VALUE) + { + /* Unable to open the device. */ + // register_error(dev, L"CreateFile"); + goto cont_close; + } + + /* Get the Vendor ID and Product ID for this device. */ + attrib.Size = sizeof(HIDD_ATTRIBUTES); + HidD_GetAttributes(write_handle, &attrib); + // wprintf(L"Product/Vendor: %x %x\n", attrib.ProductID, attrib.VendorID); + + /* Check the VID/PID to see if we should add this + device to the enumeration list. */ + if ((vendor_id == 0x0 || attrib.VendorID == vendor_id) && (product_id == 0x0 || attrib.ProductID == product_id)) + { + const char *str; + struct hid_device_info *tmp; + PHIDP_PREPARSED_DATA pp_data = NULL; + HIDP_CAPS caps; + BOOLEAN res; + NTSTATUS nt_res; + wchar_t wstr[WSTR_LEN]; /* TODO: Determine Size */ + size_t len; + + /* VID/PID match. Create the record. */ + tmp = (struct hid_device_info *)calloc(1, sizeof(struct hid_device_info)); + if (cur_dev) + { + cur_dev->next = tmp; + } + else + { + root = tmp; + } + cur_dev = tmp; + + /* Get the Usage Page and Usage for this device. */ + res = HidD_GetPreparsedData(write_handle, &pp_data); + if (res) + { + nt_res = HidP_GetCaps(pp_data, &caps); + if (nt_res == HIDP_STATUS_SUCCESS) + { + cur_dev->usage_page = caps.UsagePage; + cur_dev->usage = caps.Usage; + } + + HidD_FreePreparsedData(pp_data); + } + + /* Fill out the record */ + cur_dev->next = NULL; + str = device_interface_detail_data->DevicePath; + if (str) + { + len = strlen(str); + cur_dev->path = (char *)calloc(len + 1, sizeof(char)); + strncpy(cur_dev->path, str, len + 1); + cur_dev->path[len] = '\0'; + } + else + cur_dev->path = NULL; + + /* Serial Number */ + res = HidD_GetSerialNumberString(write_handle, wstr, sizeof(wstr)); + wstr[WSTR_LEN - 1] = 0x0000; + cur_dev->serial_number = _wcsdup(res ? wstr : L""); + + /* Manufacturer String */ + res = HidD_GetManufacturerString(write_handle, wstr, sizeof(wstr)); + wstr[WSTR_LEN - 1] = 0x0000; + cur_dev->manufacturer_string = _wcsdup(res ? wstr : L""); + + /* Product String */ + res = HidD_GetProductString(write_handle, wstr, sizeof(wstr)); + wstr[WSTR_LEN - 1] = 0x0000; + cur_dev->product_string = _wcsdup(res ? wstr : L""); + + /* VID/PID */ + cur_dev->vendor_id = attrib.VendorID; + cur_dev->product_id = attrib.ProductID; + + /* Release Number */ + cur_dev->release_number = attrib.VersionNumber; + + /* Interface Number. It can sometimes be parsed out of the path + on Windows if a device has multiple interfaces. See + http://msdn.microsoft.com/en-us/windows/hardware/gg487473 or + search for "Hardware IDs for HID Devices" at MSDN. If it's not + in the path, it's set to -1. */ + cur_dev->interface_number = -1; + if (cur_dev->path) + { + char *interface_component = strstr(cur_dev->path, "&mi_"); + if (interface_component) + { + char *hex_str = interface_component + 4; + char *endptr = NULL; + cur_dev->interface_number = strtol(hex_str, &endptr, 16); + if (endptr == hex_str) + { + /* The parsing failed. Set interface_number to -1. */ + cur_dev->interface_number = -1; + } + } + } + } + + cont_close: + CloseHandle(write_handle); + cont: + /* We no longer need the detail data. It can be freed */ + free(device_interface_detail_data); + + device_index++; + } + + /* Close the device information handle. */ + SetupDiDestroyDeviceInfoList(device_info_set); + + return root; +} + +void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs) +{ + /* TODO: Merge this with the Linux version. This function is platform-independent. */ + struct hid_device_info *d = devs; + while (d) + { + struct hid_device_info *next = d->next; + free(d->path); + free(d->serial_number); + free(d->manufacturer_string); + free(d->product_string); + free(d); + d = next; + } +} + +HID_API_EXPORT hid_device *HID_API_CALL hid_open(unsigned short vendor_id, + unsigned short product_id, + const wchar_t *serial_number) +{ + /* TODO: Merge this functions with the Linux version. This function should be platform independent. */ + struct hid_device_info *devs, *cur_dev; + const char *path_to_open = NULL; + hid_device *handle = NULL; + + devs = hid_enumerate(vendor_id, product_id); + cur_dev = devs; + while (cur_dev) + { + if (cur_dev->vendor_id == vendor_id && cur_dev->product_id == product_id) + { + if (serial_number && (wcslen(serial_number) > 0)) + { + if (wcscmp(serial_number, cur_dev->serial_number) == 0) + { + path_to_open = cur_dev->path; + break; + } + } + else + { + path_to_open = cur_dev->path; + break; + } + } + cur_dev = cur_dev->next; + } + + if (path_to_open) + { + /* Open the device */ + handle = hid_open_path(path_to_open); + } + + hid_free_enumeration(devs); + + return handle; +} + +HID_API_EXPORT hid_device *HID_API_CALL hid_open_path(const char *path) +{ + hid_device *dev; + HIDP_CAPS caps; + PHIDP_PREPARSED_DATA pp_data = NULL; + BOOLEAN res; + NTSTATUS nt_res; + + if (hid_init() < 0) + { + return NULL; + } + + dev = new_hid_device(); + + /* Open a handle to the device */ + dev->device_handle = open_device(path, FALSE); + + /* Check validity of write_handle. */ + if (dev->device_handle == INVALID_HANDLE_VALUE) + { + /* Unable to open the device. */ + register_error(dev, L"CreateFile"); + goto err; + } + + /* Get the Input Report length for the device. */ + res = HidD_GetPreparsedData(dev->device_handle, &pp_data); + if (!res) + { + register_error(dev, L"HidD_GetPreparsedData"); + goto err; + } + nt_res = HidP_GetCaps(pp_data, &caps); + if (nt_res != HIDP_STATUS_SUCCESS) + { + register_error(dev, L"HidP_GetCaps"); + goto err_pp_data; + } + dev->output_report_length = caps.OutputReportByteLength; + dev->input_report_length = caps.InputReportByteLength; + dev->usage_page = caps.UsagePage; + dev->usage = caps.Usage; + HidD_FreePreparsedData(pp_data); + + dev->read_buf = (char *)malloc(dev->input_report_length); + + return dev; + +err_pp_data: + HidD_FreePreparsedData(pp_data); +err: + free_hid_device(dev); + return NULL; +} + +int HID_API_EXPORT HID_API_CALL hid_write_timeout(hid_device *dev, + const unsigned char *data, + size_t length, + int milliseconds) +{ + DWORD bytes_written; + BOOL res; + + unsigned char *buf; + dev->write_ol.Offset = 0; + dev->write_ol.OffsetHigh = 0; + + /* Make sure the right number of bytes are passed to WriteFile. Windows + expects the number of bytes which are in the _longest_ report (plus + one for the report number) bytes even if the data is a report + which is shorter than that. Windows gives us this value in + caps.OutputReportByteLength. If a user passes in fewer bytes than this, + create a temporary buffer which is the proper size. */ + if (length >= dev->output_report_length) + { + /* The user passed the right number of bytes. Use the buffer as-is. */ + buf = (unsigned char *)data; + } + else + { + /* Create a temporary buffer and copy the user's data + into it, padding the rest with zeros. */ + buf = (unsigned char *)malloc(dev->output_report_length); + memcpy(buf, data, length); + memset(buf + length, 0, dev->output_report_length - length); + length = dev->output_report_length; + } + + res = WriteFile(dev->device_handle, buf, (DWORD)length, NULL, &dev->write_ol); + + if (!res) + { + if (GetLastError() != ERROR_IO_PENDING) + { + /* WriteFile() failed. Return error. */ + CancelIo(dev->device_handle); + register_error(dev, L"WriteFile"); + bytes_written = -1; + goto end_of_function; + } + } + + /* Wait for the write to complete. */ + res = WaitForSingleObject(dev->write_ol.hEvent, milliseconds); + if (res != WAIT_OBJECT_0) + { + /* The WaitForSingleObject operation failed. */ + CancelIo(dev->device_handle); + register_error(dev, L"WaitForSingleObject"); + bytes_written = -1; + goto end_of_function; + } + + /* WaitForSingleObject() told us that WriteFile has completed.*/ + res = GetOverlappedResult(dev->device_handle, &dev->write_ol, &bytes_written, TRUE /*wait*/); + if (!res) + { + /* The GetOverlappedResult operation failed. */ + register_error(dev, L"GetOverlappedResult"); + bytes_written = -1; + goto end_of_function; + } + +end_of_function: + if (buf != data) + free(buf); + + return bytes_written; +} + +int HID_API_EXPORT HID_API_CALL hid_write(hid_device *dev, const unsigned char *data, size_t length) +{ + return hid_write_timeout(dev, data, length, (dev->blocking) ? -1 : 0); +} + +int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds) +{ + DWORD bytes_read = 0; + BOOL res; + + if (!dev->read_pending) + { + /* Start an Overlapped I/O read. */ + dev->read_pending = TRUE; + memset(dev->read_buf, 0, dev->input_report_length); + res = ReadFile(dev->device_handle, dev->read_buf, (DWORD)dev->input_report_length, &bytes_read, &dev->read_ol); + + if (!res) + { + if (GetLastError() != ERROR_IO_PENDING) + { + /* ReadFile() has failed. + Clean up and return error. */ + CancelIo(dev->device_handle); + dev->read_pending = FALSE; + goto end_of_function; + } + } + } + + if (milliseconds >= 0) + { + /* See if there is any data yet. */ + res = WaitForSingleObject(dev->read_ol.hEvent, milliseconds); + if (res != WAIT_OBJECT_0) + { + /* There was no data this time. Return zero bytes available, + but leave the Overlapped I/O running. */ + return 0; + } + } + + /* Either WaitForSingleObject() told us that ReadFile has completed, or + we are in non-blocking mode. Get the number of bytes read. The actual + data has been copied to the data[] array which was passed to ReadFile(). */ + res = GetOverlappedResult(dev->device_handle, &dev->read_ol, &bytes_read, TRUE /*wait*/); + + /* Set pending back to false, even if GetOverlappedResult() returned error. */ + dev->read_pending = FALSE; + + if (res && bytes_read > 0) + { + if (dev->read_buf[0] == 0x0) + { + /* If report numbers aren't being used, but Windows sticks a report + number (0x0) on the beginning of the report anyway. To make this + work like the other platforms, and to make it work more like the + HID spec, we'll skip over this byte. */ + size_t copy_len; + bytes_read--; + copy_len = length > bytes_read ? bytes_read : length; + memcpy(data, dev->read_buf + 1, copy_len); + } + else + { + /* Copy the whole buffer, report number and all. */ + size_t copy_len = length > bytes_read ? bytes_read : length; + memcpy(data, dev->read_buf, copy_len); + } + } + +end_of_function: + if (!res) + { + register_error(dev, L"GetOverlappedResult"); + return -1; + } + + return bytes_read; +} + +int HID_API_EXPORT HID_API_CALL hid_read(hid_device *dev, unsigned char *data, size_t length) +{ + return hid_read_timeout(dev, data, length, (dev->blocking) ? -1 : 0); +} + +int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *dev, int nonblock) +{ + dev->blocking = !nonblock; + return 0; /* Success */ +} + +int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length) +{ + BOOL res = HidD_SetFeature(dev->device_handle, (PVOID)data, (DWORD)length); + if (!res) + { + register_error(dev, L"HidD_SetFeature"); + return -1; + } + + return (int)length; +} + +int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length) +{ + BOOL res; +#if 0 + res = HidD_GetFeature(dev->device_handle, data, length); + if (!res) { + register_error(dev, L"HidD_GetFeature"); + return -1; + } + return 0; /* HidD_GetFeature() doesn't give us an actual length, unfortunately */ +#else + DWORD bytes_returned; + + OVERLAPPED ol; + memset(&ol, 0, sizeof(ol)); + + res = DeviceIoControl(dev->device_handle, IOCTL_HID_GET_FEATURE, data, (DWORD)length, data, (DWORD)length, &bytes_returned, &ol); + + if (!res) + { + if (GetLastError() != ERROR_IO_PENDING) + { + /* DeviceIoControl() failed. Return error. */ + register_error(dev, L"Send Feature Report DeviceIoControl"); + return -1; + } + } + + /* Wait here until the write is done. This makes + hid_get_feature_report() synchronous. */ + res = GetOverlappedResult(dev->device_handle, &ol, &bytes_returned, TRUE /*wait*/); + if (!res) + { + /* The operation failed. */ + register_error(dev, L"Send Feature Report GetOverLappedResult"); + return -1; + } + return bytes_returned; +#endif +} + +void HID_API_EXPORT HID_API_CALL hid_close(hid_device *dev) +{ + if (!dev) + return; + CancelIo(dev->device_handle); + free_hid_device(dev); +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetManufacturerString(dev->device_handle, string, (ULONG)(sizeof(wchar_t) * maxlen)); + if (!res) + { + register_error(dev, L"HidD_GetManufacturerString"); + return -1; + } + + return 0; +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetProductString(dev->device_handle, string, (ULONG)(sizeof(wchar_t) * maxlen)); + if (!res) + { + register_error(dev, L"HidD_GetProductString"); + return -1; + } + + return 0; +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetSerialNumberString(dev->device_handle, string, (ULONG)(sizeof(wchar_t) * maxlen)); + if (!res) + { + register_error(dev, L"HidD_GetSerialNumberString"); + return -1; + } + + return 0; +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_indexed_string(hid_device *dev, + int string_index, + wchar_t *string, + size_t maxlen) +{ + BOOL res; + + res = HidD_GetIndexedString(dev->device_handle, string_index, string, (ULONG)(sizeof(wchar_t) * maxlen)); + if (!res) + { + register_error(dev, L"HidD_GetIndexedString"); + return -1; + } + + return 0; +} + +HID_API_EXPORT const wchar_t *HID_API_CALL hid_error(hid_device *dev) +{ + return (wchar_t *)dev->last_error_str; +} + +int HID_API_EXPORT hid_get_report_lengths(hid_device* device, unsigned short* output_report_length, unsigned short* input_report_length) +{ + if (output_report_length) + *output_report_length = device->output_report_length; + if (input_report_length) + *input_report_length = (unsigned short)device->input_report_length; + return 0; +} + +int HID_API_EXPORT hid_get_usage(hid_device* device, unsigned short* usage_page, unsigned short* usage) +{ + if (usage_page) + *usage_page = device->usage_page; + if (usage) + *usage = device->usage; + return 0; +} + +/*#define PICPGM*/ +/*#define S11*/ +#define P32 +#ifdef S11 +unsigned short VendorID = 0xa0a0; +unsigned short ProductID = 0x0001; +#endif + +#ifdef P32 +unsigned short VendorID = 0x04d8; +unsigned short ProductID = 0x3f; +#endif + +#ifdef PICPGM +unsigned short VendorID = 0x04d8; +unsigned short ProductID = 0x0033; +#endif + +#if 0 + int __cdecl main(int argc, char* argv[]) + { + int res; + unsigned char buf[65]; + + UNREFERENCED_PARAMETER(argc); + UNREFERENCED_PARAMETER(argv); + + /* Set up the command buffer. */ + memset(buf,0x00,sizeof(buf)); + buf[0] = 0; + buf[1] = 0x81; + + + /* Open the device. */ + int handle = open(VendorID, ProductID, L"12345"); + if (handle < 0) + printf("unable to open device\n"); + + + /* Toggle LED (cmd 0x80) */ + buf[1] = 0x80; + res = write(handle, buf, 65); + if (res < 0) + printf("Unable to write()\n"); + + /* Request state (cmd 0x81) */ + buf[1] = 0x81; + write(handle, buf, 65); + if (res < 0) + printf("Unable to write() (2)\n"); + + /* Read requested state */ + read(handle, buf, 65); + if (res < 0) + printf("Unable to read()\n"); + + /* Print out the returned buffer. */ + for (int i = 0; i < 4; i++) + printf("buf[%d]: %d\n", i, buf[i]); + + return 0; + } +#endif + +#ifdef __cplusplus +} /* extern "C" */ +#endif diff --git a/src/lpcusbsio.c b/src/lpcusbsio.c new file mode 100644 index 0000000..b71bb31 --- /dev/null +++ b/src/lpcusbsio.c @@ -0,0 +1,1390 @@ +/* + * Copyright 2014, 2021-2022 NXP + * + * SPDX-License-Identifier: BSD-3-Clause + * + * NXP USBSIO Library to control SPI, I2C and GPIO bus over USB + */ + +#define _CRT_SECURE_NO_WARNINGS + +#include +#include +#include +#include +#include +#include "hidapi.h" +#include "lpcusbsio.h" +#include "lpcusbsio_protocol.h" +#ifdef _WIN32 +#include +#else +#include +#endif + +/* enable debug logging */ +#define SIO_DEBUG 0 + +#ifdef _WIN32 +#define SIO_DEBUG_LOG "C:\\Temp\\libusbsio.log" +#else +#define SIO_DEBUG_LOG "/tmp/libusbsio.log" +#endif + +/***************************************************************************** + * Private types/enumerations/variables + ****************************************************************************/ +/* On windows the HID report data starts after first byte since this byte is used for reportID. */ +#define HID_REPORT_DATA_OFFSET 1 + +#define NUM_LIB_ERR_STRINGS 6 +#define NUM_FW_ERR_STRINGS 6 +#define NUM_BRIDGE_ERR_STRINGS 4 +#define MAX_FWVER_STRLEN 60 + +#define MAX_I2C_PORTS 8 +#define MAX_SPI_PORTS 8 + +typedef struct LPCUSBSIO_Port_Ctrl { + LPC_HANDLE hUsbSio; + uint8_t portNum; +} LPCUSBSIO_PortCtrl_t; + +typedef struct LPCUSBSIO_Ctrl { + + struct hid_device_info *hidInfo; + hid_device *hidDev; + uint8_t peripheralId[8]; + uint8_t transId; + uint8_t maxI2CPorts; + uint8_t maxSPIPorts; + uint8_t maxGPIOPorts; + uint32_t maxDataSize; + uint32_t fwVersion; + char fwBuild[MAX_FWVER_STRLEN]; + uint8_t outPacket[HID_SIO_PACKET_SZ + 1]; + uint8_t inPacket[HID_SIO_PACKET_SZ + 1]; + + LPCUSBSIO_PortCtrl_t i2cPorts[MAX_I2C_PORTS]; + LPCUSBSIO_PortCtrl_t spiPorts[MAX_SPI_PORTS]; +#ifdef _WIN32 + HANDLE sioMutex; +#else + pthread_mutex_t sioMutex; +#endif + + struct LPCUSBSIO_Ctrl *next; + +} LPCUSBSIO_Ctrl_t; + +struct LPCSIO_Ctrl { + struct hid_device_info *devInfoList; + + LPCUSBSIO_Ctrl_t *devList; +}; + + +#ifdef _DEBUG +#define LIB_VERSION_DBG "DEBUG " +#else +#define LIB_VERSION_DBG "" +#endif + +static const char *g_LibVersion = "NXP LIBUSBSIO v2.1c " LIB_VERSION_DBG "(" __DATE__ " " __TIME__ ")"; +static const char *g_fwInitVer = "FW Ver Unavailable"; +static char g_Version[128]; + +static struct LPCSIO_Ctrl g_Ctrl = {0, }; +static int32_t g_lastError = LPCUSBSIO_OK; + +static const wchar_t *g_LibErrMsgs[NUM_LIB_ERR_STRINGS] = { + L"No errors are recorded.", + L"HID library error.", /* LPCUSBSIO_ERR_HID_LIB */ + L"Handle passed to the function is invalid.", /* LPCUSBSIO_ERR_BAD_HANDLE */ + L"Mutex Calls failed.", /* LPCUSBSIO_ERR_SYNCHRONIZATION */ + L"Memory Allocation Error.", /* LPCUSBSIO_ERR_MEM_ALLOC */ + L"Mutex Creation Error.", /* LPCUSBSIO_ERR_MUTEX_CREATE */ +}; + +static const wchar_t *g_fwErrMsgs[NUM_FW_ERR_STRINGS] = { + L"Firmware error.", /* catch-all firmware error */ + L"Fatal error happened", /* LPCUSBSIO_ERR_FATAL */ + L"Transfer aborted due to NAK", /* LPCUSBSIO_ERR_I2C_NAK */ + L"Transfer aborted due to bus error", /* LPCUSBSIO_ERR_I2C_BUS */ + L"No acknowledgement received from slave address", /* LPCUSBSIO_ERR_I2C_SLAVE_NAK */ + L"I2C bus arbitration lost to other master", /* LPCUSBSIO_ERR_I2C_SLAVE_NAK */ +}; + +static const wchar_t *g_BridgeErrMsgs[NUM_BRIDGE_ERR_STRINGS + 1] = { + L"Transaction timed out.", /* LPCUSBSIO_ERR_TIMEOUT */ + L"Invalid HID_SIO Request or Request not supported in this version.", /* LPCUSBSIO_ERR_INVALID_CMD */ + L"Invalid parameters are provided for the given Request.", /* LPCUSBSIO_ERR_INVALID_PARAM */ + L" Partial transfer completed.", /* LPCUSBSIO_ERR_PARTIAL_DATA */ + L" Unsupported Error Code", /* Error code not supported by library */ +}; + +/***************************************************************************** + * Public types/enumerations/variables + ****************************************************************************/ + +/***************************************************************************** + * Private functions + ****************************************************************************/ + +static int32_t LibCleanup(); + +#if SIO_DEBUG>0 + +#ifdef _DEBUG +#warning LIBUSBSIO Debug logging is enabled +#else +#error LIBUSBSIO Debug logging should not be enabled in non-debug build +#endif + +void LogText(const char* text) +{ + static FILE* f = NULL; + + if(!f) + f = fopen(SIO_DEBUG_LOG, "a"); + + if(f) + { + fputs(text, f); + fflush(f); + } +} + +void Log(const char* format, ...) +{ + char buff[1024]; + + va_list args; + va_start(args, format); + + vsnprintf(buff, sizeof(buff), format, args); + LogText(buff); + + va_end(args); +} +#else +#define LogText(x) +#define Log(x, ...) +#endif + +static struct hid_device_info *GetDevAtIndex(uint32_t index) +{ + struct hid_device_info *cur_dev = g_Ctrl.devInfoList; + int32_t count = 0; + + while (cur_dev) { + if (count++ == index) { + break; + } + + cur_dev = cur_dev->next; + } + return cur_dev; +} + +static int32_t validHandle(LPCUSBSIO_Ctrl_t *dev) +{ + LPCUSBSIO_Ctrl_t *curDev = g_Ctrl.devList; + + while (dev != curDev) { + curDev = curDev->next; + } + + return (curDev == NULL) ? 0 : 1; +} + +static int32_t validPortHandle(LPC_HANDLE hPort) +{ + uintptr_t portAdr = (uintptr_t)hPort; + uintptr_t lowAdr, highAdr; + LPCUSBSIO_Ctrl_t *curDev = g_Ctrl.devList; + int32_t ret = 0; + + while (NULL != curDev) { + lowAdr = (uintptr_t)&curDev->i2cPorts[0]; + highAdr = lowAdr + ((MAX_I2C_PORTS + MAX_SPI_PORTS)* sizeof(LPCUSBSIO_PortCtrl_t)); + + if ((portAdr >= lowAdr) && (portAdr <= highAdr)) { + ret = 1; + break; + } + curDev = curDev->next; + } + + return ret; +} + +static void freeDevice(LPCUSBSIO_Ctrl_t *dev) +{ + LPCUSBSIO_Ctrl_t *curDev = g_Ctrl.devList; + + if (curDev == dev) { + g_Ctrl.devList = dev->next; + } + else { + while (curDev) { + if (curDev->next == dev) { + /* update linked list */ + curDev->next = dev->next; + break; + } + curDev = curDev->next; + } + } + free(dev); + + /* unload HID library if all devices are closed. */ + if (g_Ctrl.devList == NULL) { + hid_free_enumeration(g_Ctrl.devInfoList); + g_Ctrl.devInfoList = NULL; + + // potential place to unload HID library + LibCleanup(); + } +} + +static const wchar_t *GetErrorString(int32_t err) +{ + const wchar_t *retStr = g_LibErrMsgs[0]; + int index = abs(err); + + if (index < 0x10) { + retStr = (index < NUM_LIB_ERR_STRINGS) ? g_LibErrMsgs[index] : g_LibErrMsgs[0]; + } + else if (index < 0x20) { + index -= 0x10; + retStr = (index < NUM_FW_ERR_STRINGS) ? g_fwErrMsgs[index] : g_fwErrMsgs[0]; + } + else if (index < 0x30) { + index -= 0x20; + retStr = (index < NUM_BRIDGE_ERR_STRINGS) ? g_BridgeErrMsgs[index] : g_BridgeErrMsgs[NUM_BRIDGE_ERR_STRINGS]; + } + + return retStr; +} + +static int32_t ConvertResp(int32_t res) +{ + int ret; + + if (res == HID_SIO_RES_OK) { + ret = LPCUSBSIO_OK; + } + else { + ret = -(res + 0x10); + } + return ret; +} + +static int32_t SIO_SendRequest(LPCUSBSIO_Ctrl_t *dev, uint8_t portNum, uint8_t req, uint8_t *outData, uint32_t outDataLen, uint8_t *inData, uint32_t *inLen) +{ + HID_SIO_OUT_REPORT_T *pOut; + HID_SIO_IN_REPORT_T *pIn; + int32_t res = 0; + uint8_t read_pending; + uint32_t outLen = outDataLen; + uint32_t oneTx; + + Log("SIO_SendRequest(dev, portNum=%d, req=0x%x, outData, outLen=%d, inData, inLen)\n", portNum, req, outLen); + + if (((outLen > 0) && (outData == NULL)) || ((inLen != NULL) && (inData == NULL))) { + /* Param Error */ + return g_lastError = LPCUSBSIO_ERR_INVALID_PARAM; + } + +#if SIO_DEBUG>0 + if(outDataLen) + { + uint32_t i; + Log(" outData[%d]: ", outDataLen); + for(i=0; isioMutex, INFINITE) != WAIT_OBJECT_0) { + return g_lastError = LPCUSBSIO_ERR_SYNCHRONIZATION; + } +#else + if (pthread_mutex_lock(&dev->sioMutex) != 0) { + return g_lastError = LPCUSBSIO_ERR_SYNCHRONIZATION; + } +#endif + dev->outPacket[0] = 0; + g_lastError = LPCUSBSIO_OK; + pOut = (HID_SIO_OUT_REPORT_T *)&dev->outPacket[HID_REPORT_DATA_OFFSET]; + pOut->transId = dev->transId++; + pOut->sesId = portNum; + pOut->req = req; + pOut->transfer_len = HID_SIO_CALC_TRANSFER_LEN(outLen); + pOut->packet_num = 0; + do { + if (outLen > HID_SIO_PACKET_DATA_SZ) { + oneTx = HID_SIO_PACKET_DATA_SZ; + } + else { + oneTx = outLen; + } + + pOut->packet_len = oneTx + HID_SIO_PACKET_HEADER_SZ; + + Log("SIO_SendRequest: transId=%d, packet_num=%d, packet_len=%d, transfer_len=%d\n", pOut->transId, pOut->packet_num, pOut->packet_len, pOut->transfer_len); + + memset(&pOut->data[0], 0, HID_SIO_PACKET_DATA_SZ); + memcpy(&pOut->data[0], outData, oneTx); + + /* the +1 is for HID_REPORT_DATA_OFFSET */ + res = hid_write(dev->hidDev, &dev->outPacket[0], HID_SIO_PACKET_SZ + 1); + + outLen -= oneTx; + outData += oneTx; + pOut->packet_num++; + + Log("SIO_SendRequest: result=%d, outLen remaining=%d\n", res, outLen); + + } while ((res > 0) && ((outLen > 0))); + + /* Start Read */ + if (inLen != NULL) { + *inLen = 0; + } + read_pending = 1; + while ((res> 0) && (read_pending)) { + res = hid_read_timeout(dev->hidDev, &dev->inPacket[0], HID_SIO_PACKET_SZ + 1, LPCUSBSIO_READ_TMO); + + Log("SIO_SendRequest: hid_read_timeout result=%d\n", res); + + if (res > 0) { + /* check reponse received from LPC */ + pIn = (HID_SIO_IN_REPORT_T *)&dev->inPacket[0]; + + Log("SIO_SendRequest: input packet: resp=%d, transId=%d, packet_len=%d, packet_num=%d, transfer_len=%d\n", pIn->resp, pIn->transId, pIn->packet_len, pIn->packet_num, pIn->transfer_len); + + if (pIn->transId != pOut->transId) { + /* May be previous response discard it. */ + Log("SIO_SendRequest: pIn->transId != pOut->transId (%d != %d), discard\n", pIn->transId, pOut->transId); + continue; + } + else { + if (pIn->resp == HID_SIO_RES_OK) { + if (inLen != NULL) { + memcpy(inData, &pIn->data[0], pIn->packet_len - HID_SIO_PACKET_HEADER_SZ); + inData += pIn->packet_len - HID_SIO_PACKET_HEADER_SZ; + *inLen += pIn->packet_len - HID_SIO_PACKET_HEADER_SZ; + } + if ((pIn->packet_num * HID_SIO_PACKET_SZ + pIn->packet_len) == pIn->transfer_len) { + Log("SIO_SendRequest: finished\n"); + read_pending = 0; + res = LPCUSBSIO_OK; + } + else { + Log("SIO_SendRequest: not finished\n"); + } + } + else { + /* update status */ + res = ConvertResp(pIn->resp); + Log("SIO_SendRequest: ConvertResp res=%d\n", res); + read_pending = 0; + } + } + } + else if (res == 0) { + Log("SIO_SendRequest: wait timeout!\n"); + res = LPCUSBSIO_ERR_TIMEOUT; + read_pending = 0; + } + } +#ifdef _WIN32 + if (!ReleaseMutex(dev->sioMutex)) { + res = LPCUSBSIO_ERR_SYNCHRONIZATION; + } +#else + if (pthread_mutex_unlock(&dev->sioMutex) != 0) { + res = LPCUSBSIO_ERR_SYNCHRONIZATION; + } +#endif + Log("SIO_SendRequest: returning %d\n", res); + return g_lastError = res; +} + +static int32_t GPIO_SendCmd(LPC_HANDLE hUsbSio, uint8_t port, uint32_t cmd, uint32_t setPins, uint32_t clrPins, uint32_t* status) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + int32_t res; + uint8_t *outData; + uint8_t *inData; + uint32_t inLen; + + if (validHandle(hUsbSio) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + /* construct req packet */ + outData = (uint8_t *)malloc(8); + inData = (uint8_t *)malloc(4); + if ((outData != NULL) && (inData != NULL)) { + memcpy(outData, &setPins, sizeof(uint32_t)); + memcpy(outData + 4, &clrPins, sizeof(uint32_t)); + + res = SIO_SendRequest(dev, port, cmd, outData, 8, inData, &inLen); + if (res == LPCUSBSIO_OK) { + /* parse response */ + res = inLen; + if (res != 0) { + /* copy data back to user buffer */ + *status = *((uint32_t*)inData); + } + } + free(outData); + free(inData); + } + else { + g_lastError = LPCUSBSIO_ERR_MEM_ALLOC; + res = LPCUSBSIO_ERR_MEM_ALLOC; + } + return res; +} + +void free_hid_dev(struct hid_device_info *dev) +{ + dev->next = NULL; + hid_free_enumeration(dev); +} + +/***************************************************************************** + * Public functions + ****************************************************************************/ + +LPCUSBSIO_API int32_t LPCUSBSIO_GetNumPorts(uint32_t vid, uint32_t pid) +{ + struct hid_device_info *cur_dev; + struct hid_device_info *temp_dev; + struct hid_device_info *prev_dev = NULL; + int32_t count = 0; + + Log("LPCUSBSIO_GetNumPorts(vid=0x%x, pid=0x%x)\n", vid, pid); + + /* free any HID device structures if we were called previously */ + if (g_Ctrl.devInfoList != NULL) { + hid_free_enumeration(g_Ctrl.devInfoList); + g_Ctrl.devInfoList = NULL; + } + + cur_dev = g_Ctrl.devInfoList = hid_enumerate(vid, pid); + + Log("hid_enumerate returns %p\n", cur_dev); + + while (cur_dev) + { +#if SIO_DEBUG + char ps[512]; + wcstombs(ps, cur_dev->product_string, sizeof(ps)-1); + Log(" #if=%d product_string=%s ...", cur_dev->interface_number, ps); +#endif + + /* iterate through the list and remove non-SIO devices */ +#ifdef __MACH__ + /* usage_page only usable on Win/Mac */ + if (cur_dev->usage_page != (0xFF00| HID_USAGE_PAGE_SERIAL_IO)) + { +#else + /* interface name used instead of usage_page indication */ + if (wcsncmp(cur_dev->product_string, L"LPCSIO", 6) != 0 && wcsncmp(cur_dev->product_string, L"MCUSIO", 6) != 0) + { +#endif + temp_dev = cur_dev->next; + /* Update head pointer if the head is removed */ + if (g_Ctrl.devInfoList == cur_dev) { + g_Ctrl.devInfoList = temp_dev; + } + /*If previously valid device found then point it to next node */ + if (prev_dev != NULL) { + prev_dev->next = temp_dev; + } + free_hid_dev(cur_dev); + cur_dev = temp_dev; + Log("skipping\n"); + continue; + } + Log("using as device %d\n", count); + count++; + prev_dev = cur_dev; + cur_dev = cur_dev->next; + } + + Log("LPCUSBSIO_GetNumPorts returns %d\n", count); + + return count; +} + +LPCUSBSIO_API int32_t LPCUSBSIO_GetDeviceInfo(uint32_t index, HIDAPI_DEVICE_INFO_T* pInfo) +{ + struct hid_device_info* dev = GetDevAtIndex(index); + + if (dev) + { + memset(pInfo, 0, sizeof(*pInfo)); + pInfo->path = dev->path; + pInfo->vendor_id = dev->vendor_id; + pInfo->product_id = dev->product_id; + pInfo->serial_number = dev->serial_number; + pInfo->release_number = dev->release_number; + pInfo->manufacturer_string = dev->manufacturer_string; + pInfo->product_string = dev->product_string; + pInfo->interface_number = dev->interface_number; + + return LPCUSBSIO_OK; + } + else + { + return LPCUSBSIO_ERR_BAD_HANDLE; + } +} + +LPCUSBSIO_API LPC_HANDLE LPCUSBSIO_Open(uint32_t index) +{ + hid_device *pHid = NULL; + LPCUSBSIO_Ctrl_t *dev = NULL; + struct hid_device_info *cur_dev = GetDevAtIndex(index); + int32_t res; + uint8_t *inData; + uint32_t inLen; + + Log("LPCUSBSIO_Open(index=%d, dev_path=%s)\n", index, (cur_dev && cur_dev->path) ? cur_dev->path : "nil"); + + if (cur_dev) { + pHid = hid_open_path(cur_dev->path); + + Log("LPCUSBSIO_Open: hid_open_path returns %p\n", pHid); + + if (pHid) { + dev = malloc(sizeof(LPCUSBSIO_Ctrl_t)); + if (dev != NULL) { + memset(dev, 0, sizeof(LPCUSBSIO_Ctrl_t)); + dev->hidDev = pHid; + dev->hidInfo = cur_dev; + g_lastError = LPCUSBSIO_OK; + + /* insert at top */ + dev->next = g_Ctrl.devList; + g_Ctrl.devList = dev; + /* Set all calls to this hid device as blocking. */ + // hid_set_nonblocking(dev->hidDev, 0); + inData = (uint8_t *)malloc(12 + MAX_FWVER_STRLEN); +#ifdef _WIN32 + dev->sioMutex = CreateMutex(NULL, FALSE, NULL); + if (dev->sioMutex == NULL) { + g_lastError = LPCUSBSIO_ERR_MUTEX_CREATE; + if (inData != NULL) { + free(inData); + } + return NULL; + } +#else + res = pthread_mutex_init(&dev->sioMutex, NULL); + if (res != 0) { + g_lastError = LPCUSBSIO_ERR_MUTEX_CREATE; + if (inData != NULL) { + free(inData); + } + return NULL; + } +#endif + if (inData != NULL) { + memset(inData, 0, 12 + MAX_FWVER_STRLEN); + /* Send HID_SIO_REQ_DEV_INFO */ + res = SIO_SendRequest(dev, 0, HID_SIO_REQ_DEV_INFO, NULL, 0, inData, &inLen); + if (res == LPCUSBSIO_OK) { + /* parse response */ + if (inLen >= 12) { + dev->maxI2CPorts = inData[0]; + dev->maxSPIPorts = inData[1]; + dev->maxGPIOPorts = inData[2]; + dev->maxDataSize = *((uint32_t*)(inData + 4)); + dev->fwVersion = *((uint32_t*)(inData + 8)); + /* copy data back to user buffer */ + #ifdef _WIN32 + sprintf_s(&dev->fwBuild[0], MAX_FWVER_STRLEN, "FW %d.%d %s", + (dev->fwVersion >> 16), + (dev->fwVersion & 0xFFFF), + inData + 12); + #else + sprintf(&dev->fwBuild[0], "FW %d.%d %s", + (dev->fwVersion >> 16), + (dev->fwVersion & 0xFFFF), + inData + 12); + #endif + } + + } + else { + memcpy(&dev->fwBuild[0], &g_fwInitVer[0], strlen(g_fwInitVer)); + } + free(inData); + } + } + } + } + Log("LPCUSBSIO_Open: returning %p\n", dev); + return (LPC_HANDLE) dev; +} + +LPCUSBSIO_API int32_t LPCUSBSIO_Close(LPC_HANDLE hUsbSio) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + int32_t res; + uint8_t i; + + Log("LPCUSBSIO_Close(hUsbSio=%p)\n", hUsbSio); + + if (validHandle(hUsbSio) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + + for (i = 0; i < dev->maxI2CPorts; i++) { + /* For each I2C port, check if it is open */ + if (dev->i2cPorts[i].hUsbSio == dev) { + /* If I2C port is open, then close it */ + res = I2C_Close(&dev->i2cPorts[i]); + } + } + + for (i = 0; i < dev->maxSPIPorts; i++) { + if (dev->spiPorts[i].hUsbSio == dev) { + /* Valid SPI port found, so close it */ + res = SPI_Close(&dev->spiPorts[i]); + } + } +#ifdef _WIN32 + if (dev->sioMutex != NULL) { + CloseHandle(dev->sioMutex); + dev->sioMutex = NULL; + } +#else + pthread_mutex_destroy(&dev->sioMutex); +#endif + hid_close(dev->hidDev); + freeDevice(dev); + + (void)(res); + return LPCUSBSIO_OK; +} + +LPCUSBSIO_API const wchar_t *LPCUSBSIO_Error(LPC_HANDLE hUsbSio) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + const wchar_t *retStr = NULL; + + if (LPCUSBSIO_ERR_HID_LIB == g_lastError) { + retStr = hid_error(dev->hidDev); + } else { + retStr = GetErrorString(g_lastError); + } + + return retStr; +} + +LPCUSBSIO_API const char *LPCUSBSIO_GetVersion(LPC_HANDLE hUsbSio) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + uint32_t index = 0; + + /* copy library version */ + memcpy(&g_Version[index], &g_LibVersion[0], strlen(g_LibVersion)); + index += (uint32_t)strlen(g_LibVersion); + + /* if handle is good copy firmware version */ + if (validHandle(hUsbSio) != 0) { + g_Version[index] = '/'; + index++; + /* copy firmware version */ + memcpy(&g_Version[index], &dev->fwBuild[0], strlen(dev->fwBuild)); + index += (uint32_t)strlen(dev->fwBuild); + } + + return &g_Version[0]; +} + +LPCUSBSIO_API uint32_t LPCUSBSIO_GetNumI2CPorts(LPC_HANDLE hUsbSio) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + + if (validHandle(hUsbSio) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + return dev->maxI2CPorts; +} + +LPCUSBSIO_API uint32_t LPCUSBSIO_GetNumSPIPorts(LPC_HANDLE hUsbSio) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + + if (validHandle(hUsbSio) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + return dev->maxSPIPorts; +} + +LPCUSBSIO_API uint32_t LPCUSBSIO_GetNumGPIOPorts(LPC_HANDLE hUsbSio) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + + if (validHandle(hUsbSio) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + return dev->maxGPIOPorts; +} + +LPCUSBSIO_API uint32_t LPCUSBSIO_GetMaxDataSize(LPC_HANDLE hUsbSio) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + + if (validHandle(hUsbSio) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + return dev->maxDataSize; +} + +LPCUSBSIO_API int32_t LPCUSBSIO_GetLastError() +{ + return g_lastError; +} +/******************************** I2C functions *****************************************/ + +LPCUSBSIO_API LPC_HANDLE I2C_Open(LPC_HANDLE hUsbSio, I2C_PORTCONFIG_T *config, uint8_t portNum) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *) hUsbSio; + int32_t res; + uint8_t *outData; + LPC_HANDLE retHandle = NULL; + + + if ((validHandle(hUsbSio) == 0) || (config == NULL) || (portNum >= dev->maxI2CPorts)) { + g_lastError = LPCUSBSIO_ERR_INVALID_PARAM; + return NULL; + } + + /* construct req packet */ + outData = (uint8_t *)malloc(sizeof(I2C_PORTCONFIG_T)); + if (outData != NULL) { + memcpy(outData, config, sizeof(I2C_PORTCONFIG_T)); + res = SIO_SendRequest(dev, portNum, HID_I2C_REQ_INIT_PORT, outData, sizeof(I2C_PORTCONFIG_T), NULL, NULL); + if (res == LPCUSBSIO_OK) { + dev->i2cPorts[portNum].portNum = portNum; + dev->i2cPorts[portNum].hUsbSio = (LPC_HANDLE)dev; + retHandle = (LPC_HANDLE)&dev->i2cPorts[portNum]; + } + free(outData); + } + + return retHandle; +} + +LPCUSBSIO_API int32_t I2C_Close(LPC_HANDLE hI2C) +{ + LPCUSBSIO_PortCtrl_t *devI2c = (LPCUSBSIO_PortCtrl_t *)hI2C; + int32_t res; + if (validPortHandle(hI2C) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + res = SIO_SendRequest(devI2c->hUsbSio, devI2c->portNum, HID_I2C_REQ_DEINIT_PORT, NULL, 0, NULL, NULL); + if (res == LPCUSBSIO_OK) { + devI2c->portNum = 0; + devI2c->hUsbSio = NULL; + } + return res; +} + + +LPCUSBSIO_API int32_t I2C_DeviceRead(LPC_HANDLE hI2C, + uint8_t deviceAddress, + uint8_t *buffer, + uint16_t sizeToTransfer, + uint8_t options) +{ + LPCUSBSIO_PortCtrl_t *devI2c = (LPCUSBSIO_PortCtrl_t *)hI2C; + LPCUSBSIO_Ctrl_t *dev; + int32_t res; + HID_I2C_RW_PARAMS_T param; + uint8_t *outData; + uint8_t *inData; + uint32_t inLen; + + if (validPortHandle(hI2C) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + /* get the SIO Device*/ + dev = (LPCUSBSIO_Ctrl_t *)devI2c->hUsbSio; + + /* do parameter check */ + if ((sizeToTransfer > dev->maxDataSize) || + ((sizeToTransfer > 0) && (buffer == NULL)) || + (deviceAddress > 127)) { + + return g_lastError = LPCUSBSIO_ERR_INVALID_PARAM; + } + param.length = sizeToTransfer; + param.options = options; + param.slaveAddr = deviceAddress; + /* construct req packet */ + outData = (uint8_t *)malloc(sizeof(HID_I2C_RW_PARAMS_T)); + inData = (uint8_t *)malloc(sizeToTransfer); + if ((outData != NULL) && (inData != NULL)) { + memcpy(outData, ¶m, sizeof(HID_I2C_RW_PARAMS_T)); + + res = SIO_SendRequest(dev, devI2c->portNum, HID_I2C_REQ_DEVICE_READ, outData, sizeof(HID_I2C_RW_PARAMS_T), inData, &inLen); + if (res == LPCUSBSIO_OK) { + /* copy data back to user buffer */ + memcpy(buffer, inData, inLen); + res = inLen; + } + free(outData); + free(inData); + } + else { + g_lastError = LPCUSBSIO_ERR_MEM_ALLOC; + res = LPCUSBSIO_ERR_MEM_ALLOC; + } + + return res; +} + +LPCUSBSIO_API int32_t I2C_DeviceWrite(LPC_HANDLE hI2C, + uint8_t deviceAddress, + uint8_t *buffer, + uint16_t sizeToTransfer, + uint8_t options) +{ + LPCUSBSIO_PortCtrl_t *devI2c = (LPCUSBSIO_PortCtrl_t *)hI2C; + LPCUSBSIO_Ctrl_t *dev; + int32_t res; + HID_I2C_RW_PARAMS_T param; + uint8_t *outData; + + if (validPortHandle(hI2C) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + /* get the SIO Device*/ + dev = (LPCUSBSIO_Ctrl_t *)devI2c->hUsbSio; + + /* do parameter check */ + if ((sizeToTransfer > dev->maxDataSize) || + ((sizeToTransfer > 0) && (buffer == NULL)) || + (deviceAddress > 127)) { + + return g_lastError = LPCUSBSIO_ERR_INVALID_PARAM; + } + + param.length = sizeToTransfer; + param.options = options; + param.slaveAddr = deviceAddress; + /* construct req packet */ + outData = (uint8_t *)malloc(sizeToTransfer + sizeof(HID_I2C_RW_PARAMS_T)); + if (outData != NULL) { + /* copy params */ + memcpy(outData, ¶m, sizeof(HID_I2C_RW_PARAMS_T)); + /* copy data buffer now */ + memcpy(outData + sizeof(HID_I2C_RW_PARAMS_T), buffer, sizeToTransfer); + + res = SIO_SendRequest(dev, devI2c->portNum, HID_I2C_REQ_DEVICE_WRITE, outData, sizeof(HID_I2C_RW_PARAMS_T)+sizeToTransfer, NULL, NULL); + + if (res == LPCUSBSIO_OK) { + /* update user on transfered size */ + res = sizeToTransfer; + } + free(outData); + } + else { + g_lastError = LPCUSBSIO_ERR_MEM_ALLOC; + res = LPCUSBSIO_ERR_MEM_ALLOC; + } + + return res; +} + +LPCUSBSIO_API int32_t I2C_FastXfer(LPC_HANDLE hI2C, I2C_FAST_XFER_T *xfer) +{ + LPCUSBSIO_PortCtrl_t *devI2c = (LPCUSBSIO_PortCtrl_t *)hI2C; + LPCUSBSIO_Ctrl_t *dev; + int32_t res; + HID_I2C_XFER_PARAMS_T param; + uint8_t *outData; + uint8_t *inData; + uint32_t inLen; + + if (validPortHandle(hI2C) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + /* get the SIO Device*/ + dev = (LPCUSBSIO_Ctrl_t *)devI2c->hUsbSio; + + /* do parameter check */ + if ((xfer->txSz > dev->maxDataSize) || (xfer->rxSz > dev->maxDataSize) || + ((xfer->txSz > 0) && (xfer->txBuff == NULL)) || + ((xfer->rxSz > 0) && (xfer->rxBuff == NULL)) || + (xfer->slaveAddr > 127) ) { + + return g_lastError = LPCUSBSIO_ERR_INVALID_PARAM; + } + param.txLength = xfer->txSz; + param.rxLength = xfer->rxSz; + param.options = xfer->options; + param.slaveAddr = xfer->slaveAddr; + /* construct req packet */ + outData = (uint8_t *)malloc(sizeof(HID_I2C_XFER_PARAMS_T)+xfer->txSz); + inData = (uint8_t *)malloc(xfer->rxSz); + if ((outData != NULL) && (inData != NULL)) { + /* copy params */ + memcpy(outData, ¶m, sizeof(HID_I2C_XFER_PARAMS_T)); + /* copy data buffer now */ + memcpy(outData + sizeof(HID_I2C_XFER_PARAMS_T), &xfer->txBuff[0], xfer->txSz); + + res = SIO_SendRequest(dev, devI2c->portNum, HID_I2C_REQ_DEVICE_XFER, outData, sizeof(HID_I2C_XFER_PARAMS_T)+xfer->txSz, inData, &inLen); + + if (res == LPCUSBSIO_OK) { + /* parse response */ + res = inLen; + if (res != 0) { + /* copy data back to user buffer */ + memcpy(&xfer->rxBuff[0], inData, res); + } + else { + /* else it should be Tx only transfer. Update transferred size. */ + res = xfer->txSz; + } + } + free(outData); + free(inData); + } + else { + g_lastError = LPCUSBSIO_ERR_MEM_ALLOC; + res = LPCUSBSIO_ERR_MEM_ALLOC; + } + + return res; +} + +LPCUSBSIO_API int32_t I2C_Reset(LPC_HANDLE hI2C) +{ + LPCUSBSIO_PortCtrl_t *devI2c = (LPCUSBSIO_PortCtrl_t *)hI2C; + LPCUSBSIO_Ctrl_t *dev; + int32_t res; + + if (validPortHandle(hI2C) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + + /* get the SIO Device*/ + dev = (LPCUSBSIO_Ctrl_t *)devI2c->hUsbSio; + + res = SIO_SendRequest(dev, devI2c->portNum, HID_I2C_REQ_RESET, NULL, 0, NULL, NULL); + + return res; +} + +/******************************** SPI functions *****************************************/ + +LPCUSBSIO_API LPC_HANDLE SPI_Open(LPC_HANDLE hUsbSio, HID_SPI_PORTCONFIG_T *config, uint8_t portNum) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + int32_t res; + LPC_HANDLE retHandle = NULL; + uint8_t *outData; + + if ((validHandle(hUsbSio) == 0) || (config == NULL) || (portNum >= dev->maxSPIPorts)) { + g_lastError = LPCUSBSIO_ERR_INVALID_PARAM; + return NULL; + } + + Log("SPI_Open(hUsbSio=%p, cfg->busSpeed=%d, cfg->Options=%d, portNum=%d)\n", hUsbSio, config->busSpeed, config->Options); + + /* construct req packet */ + outData = (uint8_t *)malloc(sizeof(HID_SPI_PORTCONFIG_T)); + if (outData != NULL) { + memcpy(outData, config, sizeof(HID_SPI_PORTCONFIG_T)); + res = SIO_SendRequest(dev, portNum, HID_SPI_REQ_INIT_PORT, outData, sizeof(HID_SPI_PORTCONFIG_T), NULL, NULL); + if (res == LPCUSBSIO_OK) { + dev->spiPorts[portNum].portNum = portNum; + dev->spiPorts[portNum].hUsbSio = (LPC_HANDLE)dev; + retHandle = (LPC_HANDLE)&dev->spiPorts[portNum]; + } + free(outData); + } + + Log("SPI_Open: returning %p)\n", retHandle); + return retHandle; +} + +LPCUSBSIO_API int32_t SPI_Close(LPC_HANDLE hSPI) +{ + LPCUSBSIO_PortCtrl_t *devSPI = (LPCUSBSIO_PortCtrl_t *)hSPI; + int32_t res; + + if (validPortHandle(hSPI) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + + Log("SPI_Close(hSPI=%p\n", hSPI); + + res = SIO_SendRequest(devSPI->hUsbSio, devSPI->portNum, HID_SPI_REQ_DEINIT_PORT, NULL, 0, NULL, NULL); + if (res == LPCUSBSIO_OK) { + devSPI->portNum = 0; + devSPI->hUsbSio = NULL; + } + return res; +} + +LPCUSBSIO_API int32_t SPI_Transfer(LPC_HANDLE hSPI, SPI_XFER_T *xfer) +{ + LPCUSBSIO_PortCtrl_t *devSPI = (LPCUSBSIO_PortCtrl_t *)hSPI; + LPCUSBSIO_Ctrl_t *dev; + int32_t res; + HID_SPI_XFER_PARAMS_T param; + uint8_t *outData; + uint8_t *inData; + uint32_t inLen; + + if (validPortHandle(hSPI) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + + /* get the SIO Device*/ + dev = (LPCUSBSIO_Ctrl_t *)devSPI->hUsbSio; + + /* do parameter check */ + if ((xfer->length > dev->maxDataSize) || + ((xfer->length > 0) && ((xfer->txBuff == NULL) || (xfer->rxBuff == NULL)))) { + + return g_lastError = LPCUSBSIO_ERR_INVALID_PARAM; + } + + Log("SPI_Transfer(hSPI=%p, xfer->device=%d, xfer->length=%d, xfer->options=%d)\n", hSPI, xfer->device, xfer->length, xfer->options); + + param.length = xfer->length; + param.options = xfer->options; + param.device = xfer->device; + /* construct req packet */ + outData = (uint8_t *)malloc(sizeof(HID_SPI_XFER_PARAMS_T) + xfer->length); + inData = (uint8_t *)malloc(xfer->length); + if ((outData != NULL) && (inData != NULL)) { + /* copy params */ + memcpy(outData, ¶m, sizeof(HID_SPI_XFER_PARAMS_T)); + /* copy data buffer now */ + /* Note that the for 16 bit data transfer the bytes are transferred in Little Endian Format */ + memcpy(outData + sizeof(HID_SPI_XFER_PARAMS_T), &xfer->txBuff[0], xfer->length); + + res = SIO_SendRequest(dev, devSPI->portNum, HID_SPI_REQ_DEVICE_XFER, outData, sizeof(HID_SPI_XFER_PARAMS_T)+xfer->length, inData, &inLen); + + if (res == LPCUSBSIO_OK) { + /* parse response */ + res = inLen; + /* copy data back to user buffer */ + memcpy(&xfer->rxBuff[0], inData, res); + } + free(outData); + free(inData); + } + else { + g_lastError = LPCUSBSIO_ERR_MEM_ALLOC; + res = LPCUSBSIO_ERR_MEM_ALLOC; + } + + Log("SPI_Transfer: returning %d\n", res); + return res; +} + +LPCUSBSIO_API int32_t SPI_Reset(LPC_HANDLE hSPI) +{ + LPCUSBSIO_PortCtrl_t *devSPI = (LPCUSBSIO_PortCtrl_t *)hSPI; + LPCUSBSIO_Ctrl_t *dev; + int32_t res; + + if (validPortHandle(hSPI) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + + Log("SPI_Reset(hSPI=%p)\n", hSPI); + + /* get the SIO Device*/ + dev = (LPCUSBSIO_Ctrl_t *)devSPI->hUsbSio; + + res = SIO_SendRequest(dev, devSPI->portNum, HID_SPI_REQ_RESET, NULL, 0, NULL, NULL); + + Log("SPI_Reset: returning %d\n", res); + return res; +} + +/******************************** GPIO functions *****************************************/ +LPCUSBSIO_API int32_t GPIO_ReadPort(LPC_HANDLE hUsbSio, uint8_t port, uint32_t* status) +{ + return GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_VALUE, 0, 0, status); +} + + +LPCUSBSIO_API int32_t GPIO_WritePort(LPC_HANDLE hUsbSio, uint8_t port, uint32_t* status) +{ + uint32_t setPins = *status; + + return GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_VALUE, setPins, ~setPins, status); +} + +LPCUSBSIO_API int32_t GPIO_SetPort(LPC_HANDLE hUsbSio, uint8_t port, uint32_t pins) +{ + uint32_t status = 0; + return GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_VALUE, pins, 0, &status); +} + +LPCUSBSIO_API int32_t GPIO_ClearPort(LPC_HANDLE hUsbSio, uint8_t port, uint32_t pins) +{ + uint32_t status = 0; + return GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_VALUE, 0, pins, &status); +} + +LPCUSBSIO_API int32_t GPIO_GetPortDir(LPC_HANDLE hUsbSio, uint8_t port, uint32_t* pPins) +{ + return GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_DIR, 0, 0, pPins); +} + +LPCUSBSIO_API int32_t GPIO_SetPortOutDir(LPC_HANDLE hUsbSio, uint8_t port, uint32_t pins) +{ + uint32_t status = 0; + return GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_DIR, pins, 0, &status); +} + +LPCUSBSIO_API int32_t GPIO_SetPortInDir(LPC_HANDLE hUsbSio, uint8_t port, uint32_t pins) +{ + uint32_t status; + return GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_DIR, 0, pins, &status); +} + +LPCUSBSIO_API int32_t GPIO_SetPin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin) +{ + uint32_t status = 0; + return GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_VALUE, (1 << pin), 0, &status); +} + +LPCUSBSIO_API int32_t GPIO_GetPin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin) +{ + uint32_t status = 0; + int32_t res = GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_VALUE, 0, 0, &status); + + if (res > 0) { + res = (status & (1 << pin)) ? 1 : 0; + } + return res; +} + +LPCUSBSIO_API int32_t GPIO_ClearPin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin) +{ + uint32_t status = 0; + return GPIO_SendCmd(hUsbSio, port, HID_GPIO_REQ_PORT_VALUE, 0, (1 << pin), &status); +} + +LPCUSBSIO_API int32_t GPIO_TogglePin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + int32_t res; + uint8_t outData; + + if (validHandle(hUsbSio) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + /* construct req packet */ + outData = pin; + + res = SIO_SendRequest(dev, port, HID_GPIO_REQ_TOGGLE_PIN, &outData, 1, NULL, NULL); + + return res; +} + +LPCUSBSIO_API int32_t GPIO_ConfigIOPin(LPC_HANDLE hUsbSio, uint8_t port, uint8_t pin, uint32_t mode) +{ + LPCUSBSIO_Ctrl_t *dev = (LPCUSBSIO_Ctrl_t *)hUsbSio; + int32_t res; + uint8_t outData[5]; + + if (validHandle(hUsbSio) == 0) { + return g_lastError = LPCUSBSIO_ERR_BAD_HANDLE; + } + /* construct req packet */ + outData[0] = (uint8_t)((mode >> 0) & 0xff); + outData[1] = (uint8_t)((mode >> 8) & 0xff); + outData[2] = (uint8_t)((mode >> 16) & 0xff); + outData[3] = (uint8_t)((mode >> 24) & 0xff); + outData[4] = pin; + + res = SIO_SendRequest(dev, port, HID_GPIO_REQ_IOCONFIG, &outData[0], 5, NULL, NULL); + + return res; +} + +////////////////////////////////////////////////////////////////////////////////////////////// +// new HID low-level functions used to simplify direct HID access from LIBUSBSIO Python wrapper + +HIDAPI_ENUM_T* g_hidapiEnums = NULL; + +LPCUSBSIO_API HIDAPI_ENUM_HANDLE HIDAPI_Enumerate(uint32_t vid, uint32_t pid, int32_t read_ex_info) +{ + HIDAPI_ENUM_T* enm = NULL; + + struct hid_device_info* devs = hid_enumerate(vid, pid); + + enm = (HIDAPI_ENUM_T*)calloc(1, sizeof(HIDAPI_ENUM_T)); + if(!enm) + { + hid_free_enumeration(devs); + return NULL; + } + + // note that devs may be NULL + enm->head = devs; + enm->pos = devs; + enm->ex_info = read_ex_info; + + // insert enum object to global list + enm->next_enum = g_hidapiEnums; + g_hidapiEnums = enm; + return (HIDAPI_ENUM_HANDLE) enm; +} + +LPCUSBSIO_API int32_t HIDAPI_EnumerateNext(HIDAPI_ENUM_HANDLE hHidEnum, HIDAPI_DEVICE_INFO_T* pInfo) +{ + HIDAPI_ENUM_T* enm = (HIDAPI_ENUM_T*)hHidEnum; + struct hid_device_info* dev = NULL; + + if(!enm || !enm->head || !enm->pos) + return 0; + + // get next device + dev = enm->pos; + enm->pos = dev->next; + + memset(pInfo, 0, sizeof(*pInfo)); + pInfo->path = dev->path; + pInfo->vendor_id = dev->vendor_id; + pInfo->product_id = dev->product_id; + pInfo->serial_number = dev->serial_number; + pInfo->release_number = dev->release_number; + pInfo->manufacturer_string = dev->manufacturer_string; + pInfo->product_string = dev->product_string; + pInfo->interface_number = dev->interface_number; + + if(enm->ex_info && dev->path) + { + hid_device* dd = hid_open_path(dev->path); + if (dd != NULL) + { + hid_get_report_lengths(dd, &pInfo->ex.output_report_length, &pInfo->ex.input_report_length); + hid_get_usage(dd, &pInfo->ex.usage_page, &pInfo->ex.usage); + pInfo->ex.is_valid = 1; + + hid_close(dd); + } + } + + return 1; +} + +LPCUSBSIO_API int32_t HIDAPI_EnumerateRewind(HIDAPI_ENUM_HANDLE hHidEnum) +{ + HIDAPI_ENUM_T* enm = (HIDAPI_ENUM_T*)hHidEnum; + if(!enm || !enm->head) + return 0; + + enm->pos = enm->head; + return 1; +} + +LPCUSBSIO_API int32_t HIDAPI_EnumerateFree(HIDAPI_ENUM_HANDLE hHidEnum) +{ + HIDAPI_ENUM_T* enm = (HIDAPI_ENUM_T*)hHidEnum; + + // find in global chain + HIDAPI_ENUM_T** ppE = &g_hidapiEnums; + int32_t found = 0; + + while(*ppE) + { + if(*ppE == enm) + { + *ppE = enm->next_enum; + found = 1; + break; + } + + ppE = &((*ppE)->next_enum); + } + + if (found) + { + hid_free_enumeration(enm->head); + free(enm); + } + + return found; +} + +LPCUSBSIO_API HIDAPI_DEVICE_HANDLE HIDAPI_DeviceOpen(char* pDevicePath) +{ + hid_device* dd = hid_open_path(pDevicePath); + return (HIDAPI_DEVICE_HANDLE)dd; +} + +LPCUSBSIO_API int32_t HIDAPI_DeviceClose(HIDAPI_DEVICE_HANDLE hDevice) +{ + hid_device* dd = (hid_device*)hDevice; + + if (!dd) + return -1; + + hid_close(dd); + return 0; +} + +LPCUSBSIO_API int32_t HIDAPI_DeviceWrite(HIDAPI_DEVICE_HANDLE hDevice, const void* data, int32_t size, uint32_t timeout_ms) +{ + hid_device* dd = (hid_device*)hDevice; + + if (!dd) + return -1; + + return hid_write_timeout(dd, (const unsigned char*)data, (size_t)size, timeout_ms); +} + +LPCUSBSIO_API int32_t HIDAPI_DeviceRead(HIDAPI_DEVICE_HANDLE hDevice, void* data, int32_t size, uint32_t timeout_ms) +{ + hid_device* dd = (hid_device*)hDevice; + + if (!dd) + return -1; + + return hid_read_timeout(dd, (unsigned char*)data, (size_t)size, timeout_ms); +} + +// called whenever some device or enumeration is closed, to see if we can unload the HID library +static int32_t LibCleanup() +{ + if(g_Ctrl.devInfoList) + return 0; + + if(g_hidapiEnums) + return 0; + + hid_exit(); + return 1; +} + +