Embedded_Drivers
/
libusbsio
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Initial commit.

This commit is contained in:
imi415 2022-05-28 20:19:43 +08:00
commit ddebae0877
Signed by: imi415
GPG Key ID: 885EC2B5A8A6F8A7
18 changed files with 7145 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
CMakeLists.txt Normal file
View File

1
LICENSE.txt Normal file
View File

@ -0,0 +1 @@
See the 'license' folder for SoftwareContentRegister.txt file and related license files.

794
include/lpcusbsio.h Normal file
View File

@ -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 <stdint.h>
#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
* <b>API description</b><br>
* 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.
* <br>
* 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.
*
* <b> S Addr Rd [A] [rxBuff0] A [rxBuff1] A ...[rxBuffN] NA P </b>
*
* - If I2C_TRANSFER_OPTIONS_NO_ADDRESS is also set.
*
* <b> S [rxBuff0] A [rxBuff1] A ...[rxBuffN] NA P </b>
*
* - if I2C_TRANSFER_OPTIONS_NACK_LAST_BYTE is not set
*
* <b> S Addr Rd [A] [rxBuff0] A [rxBuff1] A ...[rxBuffN] A P </b>
*
* - If I2C_TRANSFER_OPTIONS_STOP_BIT is not set.
*
* <b> S Addr Rd [A] [rxBuff0] A [rxBuff1] A ...[rxBuffN] NA </b>
*
* @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.
*
* <b> S Addr Wr[A] txBuff0[A] txBuff1[A] ... txBuffN[A] P </b>
*
* - If I2C_TRANSFER_OPTIONS_NO_ADDRESS is also set.
*
* <b> S txBuff0[A ] ... txBuffN[A] P </b>
*
* - if I2C_TRANSFER_OPTIONS_BREAK_ON_NACK is not set
*
* <b> S Addr Wr[A] txBuff0[A or NA] ... txBuffN[A or NA] P </b>
*
* - If I2C_TRANSFER_OPTIONS_STOP_BIT is not set.
*
* <b> S Addr Wr[A] txBuff0[A] txBuff1[A] ... txBuffN[A] </b>
*
* @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.
*
* <b> S Addr Wr[A] txBuff0[A] txBuff1[A] ... txBuffN[A] P </b>
*
* - If I2C_FAST_XFER_OPTION_IGNORE_NACK is set in @a options member
*
* <b> S Addr Wr[A] txBuff0[A or NA] ... txBuffN[A or NA] P </b>
*
* - Read-only transfer : When @a txSz member of @a xfer is set to 0.
*
* <b> S Addr Rd[A][rxBuff0] A[rxBuff1] A ...[rxBuffN] NA P </b>
*
* - If I2C_FAST_XFER_OPTION_LAST_RX_ACK is set in @a options member
*
* <b> S Addr Rd[A][rxBuff0] A[rxBuff1] A ...[rxBuffN] A P </b>
*
* - Read-Write transfer : When @a rxSz and @ txSz members of @a xfer are non - zero.
*
* <b> S Addr Wr[A] txBuff0[A] txBuff1[A] ... txBuffN[A] <br>
* S Addr Rd[A][rxBuff0] A[rxBuff1] A ...[rxBuffN] NA P </b>
*
* @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*/

397
include/lpcusbsio_protocol.h Normal file
View File

@ -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 <stdint.h>
#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_ */

11
license/BSD-3-clause.txt Normal file
View File

@ -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.

26
license/LICENSE-hidapi-bsd.txt Normal file
View File

@ -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.

58
license/SoftwareContentRegister.txt Normal file
View File

@ -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 <alan@signal11.us>
library for Linux, Mac, Windows Ludovic Rousseau <rousseau@debian.org>
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 <alan@signal11.us>
Ludovic Rousseau <rousseau@debian.org>
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/*

19
src/hid_api/AUTHORS.txt Normal file
View File

@ -0,0 +1,19 @@
HIDAPI Authors:
Alan Ott <alan@signal11.us>:
Original Author and Maintainer
Linux, Windows, and Mac implementations
Ludovic Rousseau <rousseau@debian.org>:
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 <michal.hanak@nxp.com>
Modifications for use in libusbsio

26
src/hid_api/LICENSE-bsd.txt Normal file
View File

@ -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.

674
src/hid_api/LICENSE-gpl3.txt Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
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.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 <http://www.gnu.org/licenses/>.
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:
<program> Copyright (C) <year> <name of author>
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
<http://www.gnu.org/licenses/>.
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
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

9
src/hid_api/LICENSE-orig.txt Normal file
View File

@ -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.

13
src/hid_api/LICENSE.txt Normal file
View File

@ -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.

2
src/hid_api/ORIGIN.url Normal file
View File

@ -0,0 +1,2 @@
[InternetShortcut]
URL=https://github.com/signal11/hidapi

472
src/hid_api/hidapi/hidapi.h Normal file
View File

@ -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 <wchar.h>
#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

1009
src/hid_api/linux/hid.c Normal file
View File

File diff suppressed because it is too large Load Diff

1242
src/hid_api/mac/hid.c Normal file
View File

File diff suppressed because it is too large Load Diff

1002
src/hid_api/windows/hid.c Normal file
View File

File diff suppressed because it is too large Load Diff

1390
src/lpcusbsio.c Normal file
View File

File diff suppressed because it is too large Load Diff