Describes several attributes of a connected device. More...

Public Attributes
char	deviceID [OK_MAX_DEVICEID_LENGTH]
	NULL-terminated device ID string, max length OK_MAX_DEVICEID_LENGTH.

char	serialNumber [OK_MAX_SERIALNUMBER_LENGTH]
	NULL-terminated device serial number, max length OK_MAX_SERIALNUMBER_LENGTH.

char	productName [OK_MAX_PRODUCT_NAME_LENGTH]
	NULL-terminated product string, max length OK_MAX_PRODUCT_NAME_LENGTH.

int	productID
	Unique product identifier.

okEDeviceInterface	deviceInterface
	Enumeration of the device interface type.

okEUSBSpeed	usbSpeed
	Enumeration of USB speed for USB devices.

int	deviceMajorVersion
	Device firmware major version.

int	deviceMinorVersion
	Device firmware minor version.

int	hostInterfaceMajorVersion
	Device host interface (HDL) major version.

int	hostInterfaceMinorVersion
	Device host interface (HDL) minor version.

bool	isPLL22150Supported
	true if device contains a Cypress CY22150 PLL

bool	isPLL22393Supported
	true if device contains a Cypress CY22393 PLL

bool	isFrontPanelEnabled
	true if device indicates FrontPanel support in FPGA

int	wireWidth
	Wire width in bits.

int	triggerWidth
	Trigger width in bits.

int	pipeWidth
	Pipe width in bits.

int	registerAddressWidth
	RegisterBridge address width in bits (0 if unsupported)

int	registerDataWidth
	RegisterBridge data width in bits (0 if unsupported)

okTFlashLayout	flashSystem
	System Flash layout.

okTFlashLayout	flashFPGA
	FPGA Flash layout.

bool	hasFMCEEPROM
	True if the device can have an attached FMC EEPROM.

bool	hasResetProfiles
	True if the device supports reset profiles.

okEFPGAVendor	fpgaVendor
	Vendor of the FPGA.

int	interfaceCount

int	interfaceIndex

bool	configuresFromSystemFlash

bool	hasQuadConfigFlash
	True if the device flash has quad SPI I/O.

UINT32	supportedBandwidthModesMask

okEDeviceFamily	family
	Device family (canonical host generation axis).

okEDataport	dataport
	Host data port used for block transfers.

Detailed Description

Contains various device data including device type and support.

Member Data Documentation

◆ configuresFromSystemFlash

bool okTDeviceInfo::configuresFromSystemFlash

True if the device configures from its system flash. If false, the device is configured from its FPGA flash.

◆ dataport

okEDataport okTDeviceInfo::dataport

Derived from family but reported explicitly. Defined values are:
okDATAPORT_UNKNOWN = 0
okDATAPORT_LEGACY = 1 (FP-Gen1/2-USB)
okDATAPORT_AXI = 2 (FP-Gen3-USB)

◆ deviceInterface

okEDeviceInterface okTDeviceInfo::deviceInterface

This value is fixed by the device family and does NOT reflect the negotiated USB link speed. Use usbSpeed to inspect the negotiated link speed, and family for the canonical host generation.

Note: The names are historical and describe the transport rather than the generation: okDEVICEINTERFACE_USB3 is the FX3 generation, while FX5/FX10/FX20 devices report okDEVICEINTERFACE_GEN3.

Defined values are:
okDEVICEINTERFACE_UNKNOWN = 0
okDEVICEINTERFACE_USB2 = 1
okDEVICEINTERFACE_PCIE = 2
okDEVICEINTERFACE_USB3 = 3
okDEVICEINTERFACE_GEN3 = 4

◆ family

okEDeviceFamily okTDeviceInfo::family

Defined values are:
okDEVICEFAMILY_UNKNOWN = 0
okDEVICEFAMILY_USBGEN1 = 1 (FX2)
okDEVICEFAMILY_USBGEN2 = 2 (FX3)
okDEVICEFAMILY_USBGEN3 = 3 (FX5/FX10/FX20)
okDEVICEFAMILY_PCIEGEN1 = 4 (PCIe, e.g. XEM6110)

◆ interfaceCount

int okTDeviceInfo::interfaceCount

Number of connections to this device, typically just 1, but can be 2 for the devices in 8350 family.

◆ interfaceIndex

int okTDeviceInfo::interfaceIndex

Index of this particular device connection in 0..interfaceCount-1 range (and so usually just 0).

◆ productID

int okTDeviceInfo::productID

Standard predefined values are:
OK_PRODUCT_UNKNOWN = 0
OK_PRODUCT_XEM3001V1 = 1
OK_PRODUCT_XEM3001V2 = 2
OK_PRODUCT_XEM3010 = 3
OK_PRODUCT_XEM3005 = 4
OK_PRODUCT_XEM3001CL = 5
OK_PRODUCT_XEM3020 = 6
OK_PRODUCT_XEM3050 = 7
OK_PRODUCT_XEM9002 = 8
OK_PRODUCT_XEM3001RB = 9
OK_PRODUCT_XEM5010 = 10
OK_PRODUCT_XEM6110LX45 = 11
OK_PRODUCT_XEM6001 = 12
OK_PRODUCT_XEM6010LX45 = 13
OK_PRODUCT_XEM6010LX150 = 14
OK_PRODUCT_XEM6110LX150 = 15
OK_PRODUCT_XEM6006LX9 = 16
OK_PRODUCT_XEM6006LX16 = 17
OK_PRODUCT_XEM6006LX25 = 18
OK_PRODUCT_XEM5010LX110 = 19
OK_PRODUCT_ZEM4310 = 20
OK_PRODUCT_XEM6310LX45 = 21
OK_PRODUCT_XEM6310LX150 = 22
OK_PRODUCT_XEM6110V2LX45 = 23
OK_PRODUCT_XEM6110V2LX150 = 24
OK_PRODUCT_XEM6002LX9 = 25
OK_PRODUCT_XEM6310MTLX45T = 26
OK_PRODUCT_XEM6320LX130T = 27
OK_PRODUCT_XEM7350K70T = 28
OK_PRODUCT_XEM7350K160T = 29
OK_PRODUCT_XEM7350K410T = 30
OK_PRODUCT_XEM6310MTLX150T = 31
OK_PRODUCT_ZEM5305A2 = 32
OK_PRODUCT_ZEM5305A7 = 33
OK_PRODUCT_XEM7001A15 = 34
OK_PRODUCT_XEM7001A35 = 35
OK_PRODUCT_XEM7360K160T = 36
OK_PRODUCT_XEM7360K410T = 37
OK_PRODUCT_ZEM5310A4 = 38
OK_PRODUCT_ZEM5310A7 = 39
OK_PRODUCT_ZEM5370A5 = 40
OK_PRODUCT_XEM7010A50 = 41
OK_PRODUCT_XEM7010A200 = 42
OK_PRODUCT_XEM7310A75 = 43
OK_PRODUCT_XEM7310A200 = 44
OK_PRODUCT_XEM7320A75T = 45
OK_PRODUCT_XEM7320A200T = 46
OK_PRODUCT_XEM7305 = 47
OK_PRODUCT_FPXBARE = 48
OK_PRODUCT_XEM8350KU060 = 49
OK_PRODUCT_XEM8350KU085 = 50
OK_PRODUCT_XEM8350KU115 = 51
OK_PRODUCT_XEM8350SECONDARY = 52
OK_PRODUCT_XEM7310MTA75 = 53
OK_PRODUCT_XEM7310MTA200 = 54
OK_PRODUCT_XEM9025 = 55
OK_PRODUCT_XEM8320AU25P = 56
OK_PRODUCT_XEM8310AU25P = 57
OK_PRODUCT_FPX9301 = 58
OK_PRODUCT_XEM8370KU11P = 59
OK_PRODUCT_XEM8305AU15P = 60
OK_PRODUCT_SZGHUB1450AU10P = 61
OK_PRODUCT_SZGHUB1450AU25P = 62
OK_PRODUCT_XEM7460K160T = 63
OK_PRODUCT_XEM7460K410T = 64
Additional custom values may also be used, see OpalKelly::FrontPanel::AddCustomDevice().

◆ supportedBandwidthModesMask

UINT32 okTDeviceInfo::supportedBandwidthModesMask

Bitmask of the bandwidth modes the connected device supports. Test a mode with (supportedBandwidthModesMask & okBANDWIDTHMODE_X) != 0 (each okEBandwidthMode value is the mode's bit). Only supported on FP-Gen3-USB devices.

◆ usbSpeed

okEUSBSpeed okTDeviceInfo::usbSpeed

Defined values are:
okUSBSPEED_UNKNOWN = 0
okUSBSPEED_FULL = 1
okUSBSPEED_HIGH = 2
okUSBSPEED_SUPER = 3
okUSBSPEED_SS_GEN1X2 = 4
okUSBSPEED_SS_GEN2 = 5
okUSBSPEED_SS_GEN2X2 = 6

Public Attributes