AN144

Rev. 2.0

9

5. CP210x Host API Functions (CP2101/2/3/4/5)

The CP210x Host API is provided as a means to facilitate production of customized CP210x devices. The API

allows access to the CP210x device for retrieving and setting the VID, PID, product string, serial number, self-

power attribute, maximum power consumption, and device version.

The

CP210x

Host

API

is

provided

in

the

form

of

a

Windows

Dynamic

Link

Library

(DLL),

CP210xManufacturing.DLL. The host interface DLL communicates with the bridge controller device via the

provided device driver and the operating system's USB stack. The following is a list of the available host API

functions:

CP210x_GetNumDevices()

Returns the number of CP210x devices connected.

CP210x_GetProductString()

Returns a descriptor from the registry for a CP210x USB device.

CP210x_GetPartNumber()

Returns the 1-byte Part Number of a CP210x device.

CP210x_Open()

Opens a CP210x device as a USB device and returns a handle.

CP210x_Close()

Closes a CP210x device handle.

CP210x_SetVid()

Sets the 2-byte vendor ID of a CP210x device.

CP210x_SetPid()

Sets the 2-byte product ID of a CP210x device.

CP210x_SetProductString()

Sets the product description string of a CP210x device.

CP210x_SetInterfaceString()

Sets the interface string of a CP2105 device.

CP210x_SetSerialNumber()

Sets the serial number string of a CP210x device.

CP210x_SetSelfPower()

Sets the self-power attribute of a CP210x device.

CP210x_SetMaxPower()

Sets the maximum power consumption of a CP210x device.

CP210x_SetFlushBufferConfig()

Sets the flush buffer configuration of CP2104/5 devices.

CP210x_SetDeviceMode()

Sets the operating modes of both interfaces of a CP2105 device.

CP210x_SetDeviceVersion()

Sets version number of the CP210x device.

CP210x_SetBaudRateConfig()

Sets the baud rate configuration data of a CP210x device.

CP210x_SetLockValue()

Sets the 1-byte Lock Value of a CP210x device.

CP210x_SetPortConfig()

Sets the port configuration of a CP2101/2/3/4 device.

CP210x_SetDualPortConfig()

Sets the port configuration of a CP2105 device.

CP210x_GetDeviceProductString()

Gets the product description string of a CP210x device.

CP210x_GetDeviceInterfaceString()

Gets the interface string of a CP2105 device.

CP210x_GetDeviceSerialNumber()

Gets the serial number string of a CP210x device.

CP210x_GetDeviceVid()

Gets the vendor ID of a CP210x device.

CP210x_GetDevicePid()

Gets the product ID of a CP210x device.

CP210x_GetSelfPower()

Gets the self-power attribute of a CP210x device.

CP210x_GetMaxPower()

Gets the maximum power consumption value of a CP210x device.

CP210x_GetFlushBufferConfig()

Gets the flush buffer configuration of CP2104/5 devices.

CP210x_GetDeviceMode()

Gets the operating modes of interfaces of a CP2105 device.

CP210x_GetDeviceVersion()

Gets the version number of a CP210x device.

CP210x_GetBaudRateConfig()

Gets the baud rate configuration data of a CP210x device.

CP210x_GetLockValue()

Gets the 1-byte Lock Value of a CP210x device.

CP210x_GetPortConfig()

Gets the port configuration of a CP210x device.

CP210x_GetDualPortConfig()

Gets the port configuration of a CP2105 device.

CP210x_Reset()

Resets a CP210x device.