aProtocoldefs.h

group aProtocoldefs

BrainStem Protocol Definitions.

aProtocoldefs.h Provides protocol and BrainStem specific defines for entities, communication, and protocol specifics.

aBRAINSTEM_MAXPACKETBYTES 28

8 Bytes - Packet protocol payload maximum.

group UEI_Defines

UEI and Command support for C/C++ and Reflex languages.

Defines

ueiSPECIFIER_INDEX_MASK 0x1F

0x1F - Mask bits for Index on index byte.

ueiSPECIFIER_RETURN_MASK 0xE0

0xE0 - Mask bits for Return value on index byte.

ueiSPECIFIER_RETURN_HOST 0x20

1 << 5 - Specifier Bit for UEI response to host.

ueiSPECIFIER_RETURN_I2C 0x40

2 << 5 - Specifier Bit for UEI response to Module over I2C.

ueiSPECIFIER_RETURN_VM 0x60

3 << 5 - Specifier Bit for UEI response to VM on module.

ueiREPLY_ERROR 0x80

1 << 7 - Error flag on response in index byte.

ueiREPLY_STREAM 0x40

1 << 6 - Stream flag on response in index byte.

ueiOPTION_GET 0x40

0x40 - Option byte code for UEI Get request.

ueiOPTION_VAL 0x00

0x00 - Option byte code for UEI Val response.

ueiOPTION_SET 0x80

0x80 - Option byte code for UEI Set request.

ueiOPTION_ACK 0xC0

0xC0 - Option byte code for UEI Ack response.

ueiOPTION_MASK 0x3F

0x3F - Mask for getting command option from option byte.

ueiOPTION_OP_MASK 0xC0

0xC0 - Mask for getting Operation Get/Set/Val/Ack

ueiBYTES_CONTINUE 0x80

ueiBYTES_CONTINUE_MASK 0x7F

Analog Entity

group cmdANALOG_Defines

Analog Command defines.

Defines

cmdANALOG 30

30 - Analog command code.

group cmdANALOG_Command_Options

Defines

analogConfiguration 1

1 - Analog Configuration Option Code

analogConfigurationInput 0

0 - Input configuration

analogConfigurationOutput 1

1 - Output configuration

analogConfigurationHiZ 2

2 - High Impedance configuration

analogValue 2

2 - Analog Value Option Code

analogVoltage 3

3 - Analog Voltage Option Code

analogBulkCaptureSampleRate 4

4 - Analog Bulk Capture Sample Rate Option Code

analog_Hz_Minimum 7000

7000 - Minimum hertz sample rate

analog_Hz_Maximum 200000

200000 - Maximum hertz sample rate

analogBulkCaptureNumberOfSamples 5

5 - Bulk Capture number of samples Option Code

analogBulkCapture 6

6 - Bulk Capture Option Code

analogBulkCaptureState 7

7 - Bulk Capture State Option Code

bulkCaptureIdle 0

0 - Idle state

bulkCapturePending 1

1 - Pending state

bulkCaptureFinished 2

2 - Finished state

bulkCaptureError 3

3 - Error state

analogRange 8

8 - Analog Range Option Code

analogRange_P0V064N0V064 0

0 - +/- 64mV range

analogRange_P0V64N0V64 1

1 - +/- 640mV range

analogRange_P0V128N0V128 2

2 - +/- 128mV range

analogRange_P1V28N1V28 3

3 - +/- 1.28V range

analogRange_P1V28N0V0 4

4 - 0-1.28V range

analogRange_P0V256N0V256 5

5 - +/- 256mV range

analogRange_P2V56N2V56 6

6 - +/- 2.56V range

analogRange_P2V56N0V0 7

7 - 0-2.56V range

analogRange_P0V512N0V512 8

8 - +/- 512mV range

analogRange_P5V12N5V12 9

9 - +/- 5.12V range

analogRange_P5V12N0V0 10

10 - 0-5.12V range

analogRange_P1V024N1V024 11

11 - +/- 1.024V range

analogRange_P10V24N10V24 12

12 - +/- 10.24V range

analogRange_P10V24N0V0 13

13 - 0-10.24V range

analogRange_P2V048N0V0 14

14 - 0-2.048V range

analogRange_P4V096N0V0 15

15 - 0-4.096V range

analogEnable 9

9 - Analog Enable Option Code

analogNumberOfOptions 10

10 - Number of Options for analog, always last entry

App Entity

group cmdAPP_Defines

App Command defines.

Defines

cmdAPP 5

5 - App command code.

group cmdAPP_Command_Options

Defines

appExecute 1

1 - Execute Option Code

appReturn 2

2 - Return Option Code

Capacity Entity

group cmdCAPACITY_Defines

Capacity Command defines.

Defines

cmdCAPACITY 73

73 - Capacity command code.

group cmdCAPACITY_Command_Options

Defines

capacityUEI 1

1 - UEI Option Code

capacitySubClassSize 3

3 - SubClass size Option Code

capacityClassQuantity 4

4 - Class Quantity Option Code

capacitySubClassQuantity 5

5 - SubClass Quantity Option Code

capacityEntityGroup 6

6 - Entity Group Option Code

capacityBuild 255

255 - Build Option Code

Clock Entity

group cmdCLOCK_Defines

Clock Command defines.

Defines

cmdCLOCK 83

83 - Clock command code.

group cmdCLOCK_Command_Options

Defines

clockYear 1

1 - Year Option Code

clockMonth 2

2 - Month Option Code

clockDay 3

3 - Day Option Code

clockHour 4

4 - Hour Option Code

clockMinute 5

5 - Minute Option Code

clockSecond 6

6 - Second Option Code

clockNumberOfOptions 7

7 - Number of Options for clock, always last entry

Digital Entity

group cmdDIGITAL_Defines

Digital Command defines.

Defines

cmdDIGITAL 31

31 - Digital command code.

group cmdDIGITAL_Command_Options

Defines

digitalConfiguration 1

1 - Digital configuration Option Code

digitalConfigurationInput 0x00

0x00 - Input Configuration

digitalConfigurationOutput 0x01

0x01 - Output Configuration

digitalConfigurationRCServoInput 0x02

0x02 - RCServo Input Configuration

digitalConfigurationRCServoOutput 0x03

0x03 - RCServo Output Configuration

digitalConfigurationHiZ 0x04

0x04 - High Impedance Configuration

digitalConfigurationInputPullUp 0x00

0x00 - Input Configuration with pull-up

digitalConfigurationInputNoPull 0x04

0x04 - Input Configuration without pull-up/pull-down

digitalConfigurationInputPullDown 0x05

0x05 - Input Configuration with pull-down

digitalConfigurationSignalOutput 0x06

0x06 - Signal Output Configuration

digitalConfigurationSignalInput 0x07

0x07 - Signal Input Configuration

digitalConfigurationSignalCounterInput 0x08

0x08 - Signal Input Counter Configuration

digitalConfigurationLinkInput 0x09

0x09 - Input from a linked digital channel

digitalConfigurationLinkOutput 0x0A

0x0A - Output to a linked digital channel

digitalState 2

2 - State Option Code

digitalStateAll 3

3 - Full State Option Code

digitalTimeDelay 4

4 - Time Delay Option Code

digitalNumberOfOptions 5

5 - Number of Options for digital, always last entry

Equalizer Entity

group cmdEQUALIZER_Defines

Equalizer Command defines.

Defines

cmdEQUALIZER 15

15 - Equalizer command code.

group cmdEQUALIZER_Command_Options

Defines

equalizerReceiverConfig 1

1 - Receiver Configuration Option Code

equalizerTransmitterConfig 2

2 - Transmitter (Driver) Configuration Option Code

equalizerManualConfig 3

3 - Manual Configuration Option Code

equalizerNumberOfOptions 4

4 - Number of Options for equalizer, always last entry

group cmdEQUALIZER_Command_Constants

Defines

equalizer2p0 0

Equalizer Index for USB2.0.

equalizer3p0 1

Equalizer Index for USB3.0.

Ethernet Entity

group cmdETHERNET_Defines

Ethernet Command defines.

Defines

cmdETHERNET 39

39 - Ethernet command code.

group cmdETHERNET_Command_Options

Defines

ethernetEnabled 1

1 - Enabled

ethernetNetworkConfiguration 2

2 - Network IP Assignment Configuration

ethernetConfigurationNone 0

0 - Disable IP Assignment Option Code

ethernetConfigurationStatic 1

1 - Static IP Address Option Code

ethernetConfigurationDhcp 2

2 - DHCP Address Option Code

ethernetStaticIPv4Address 3

3 - Static IP Address

ethernetStaticIPv4Netmask 4

4 - Static IP Netmask

ethernetStaticIPv4Gateway 5

5 - Static IP Gateway

ethernetIPv4Address 6

6 - Current IP Address

ethernetIPv4Netmask 7

7 - Current IP Netmask

ethernetIPv4Gateway 8

8 - Current IP Gateway

ethernetStaticIPv4DNSAddress 9

9 - Static DNS Address

ethernetIPv4DNSAddress 10

10 - Current DNS Address

ethernetHostname 11

11 - Hostname

ethernetMACAddress 12

12 - MAC Address

ethernetInterfacePort 13

13 - Port number of TCPIP Interface

ethernetInterfacePort_RestServer_HTTP 0

0 - REST Service (HTTP) Port

ethernetInterfacePort_RestServer_HTTPS 1

1 - REST Service (HTTP) Port

ethernetInterfacePort_BrainStem_TCP 2

2 - BrainStem TCPIP Transport Port

ethernetInterfacePort_BrainStem_DiscoveryRequest 3

3 - BrainStem Multicast Discovery Request Port

ethernetInterfacePort_BrainStem_DiscoveryReply 4

4 - BrainStem Multicast Discovery Reply Port

ethernetInterfacePort_Max 5

5 - Number of options for ethernetInterfacePort

ethernetNumberOfOptions 14

14 - Number of Options for ethernet, always last entry

General Definitions

group General_Defines

Defines

cmdDEBUG 23

Debug Command.

cmdNOTIFY 24

Notify Command.

cmdLAST 96

Maximum Command.

HDBaseT Entity

group cmdHDBASET_Defines

HDBaseT Command defines.

Defines

cmdHDBASET 41

41 - HDBaseT command code.

group cmdHDBASET_Command_Options

Defines

hdbasetSerialNumber 1

1 - Serial Number Option Code

hdbasetFirmwareVersion 2

2 - Firmware Version Option Code

hdbasetState 3

3 - State Option Code

hdbasetState_devicePresent_Bit 0

0 - Device Present Bit

hdbasetState_linkUp_Bit 1

1 - Link Up Bit

hdbasetState_linkRole_Offset 2

2 - Link Role Offset

hdbasetState_linkRole_Mask 0x3

0x3 - Link Role Mask

hdbasetState_linkRole_Unknown 0

0 - Unknown Link Role

hdbasetState_linkRole_Leader 1

1 - Leader/Master Link Role

hdbasetState_linkRole_Follower 2

2 - Follower/Slave Link Role

hdbasetCableLength 4

4 - Cable Length Option Code

hdbasetMSEA 5

5 - Mean Squared Error Pair A Option Code

hdbasetMSEB 6

6 - Mean Squared Error Pair B Option Code

hdbasetRetransmissionRate 7

7 - Retransmission Rate Option Code

hdbasetLinkUtilization 8

8 - Link Utilization Option Code

hdbasetEncodingState 9

9 - HDBaseT Encoding State Option Code

hdbasetEncodingState_Unknown 0

0 - Unknown

hdbasetEncodingState_PAM16 1

1 - PAM16

hdbasetEncodingState_PAM8 2

2 - PAM8

hdbasetEncodingState_PAM4 3

3 - PAM4

hdbasetUSB2DeviceTree 10

10 - USB2 Device Tree Option Code

hdbasetUSB3DeviceTree 11

11 - USB3 Device Tree Option Code

hdbasetLinkRole 12

12 - Link Role Option Code

hdbasetLinkRole_AutoDetect 0

0 - Auto-Detected Link Role

hdbasetLinkRole_Leader 1

1 - Leader/Master Link Role

hdbasetLinkRole_Follower 2

2 - Follower/Slave Link Role

hdbasetNumberOfOptions 13

13 - Number of Options for HDBaseT, always last entry

Heartbeat Entity

group cmdHB_Defines

Heartbeat Command defines.

Defines

cmdHB 0

0 - Heartbeat command code.

group cmdHB_Command_Constants

Defines

val_HB_S2H_UP 0

val_HB_S2H_DOWN 1

val_HB_H2S_UP 2

val_HB_H2S_DOWN 3

val_HB_M2R_UP 4

val_HB_M2R_DOWN 5

I2C Entity

group cmdI2C_Defines

I2C Command defines.

Defines

cmdI2C 8

8 - I2C command code.

group cmdI2C_Command_Options

Defines

i2cSetPullup 1

1 - Set Pullup Option Code

group cmdI2C_Command_Constants

Defines

i2cDefaultSpeed 0

Default I2C Speed Setting.

i2cSpeed_100Khz 1

100kHz I2C Speed Setting

i2cSpeed_400Khz 2

400kHz I2C Speed Setting

i2cSpeed_1000Khz 3

1000kHz I2C Speed Setting

bitI2CError 0x80

Bit I2C error code.

bitI2CAck 0x40

Bit I2C ack code.

Mux Entity

group cmdMUX_Defines

Mux Command defines.

Defines

cmdMUX 6

6 - Mux command code.

group cmdMUX_Command_Options

Defines

muxEnable 1

1 - Channel Enable Option Code

muxChannel 2

2 - Channel Select Option Code

muxVoltage 3

3 - Channel Voltage Measurement Option Code

muxConfig 4

4 - Mux Mode Configuration Option Code

muxConfig_default 0

0 - Default (Manual)

muxConfig_splitMode 1

1 - Split Mode

muxConfig_channelpriority 2

2 - Channel Pririty

muxSplit 5

5 - Split Mode Configuration Option Code

muxNumberOfOptions 6

6 - Number of Options for mux, always last entry

POE Entity

group cmdPOE_Defines

POE Command defines.

Defines

cmdPOE 40

40 - POE command code.

group cmdPOE_Command_Options

Defines

poePowerMode 1

1 - Power Mode Option Code

poePowerMode_Off 0

poePowerMode_PSE 1

poePowerMode_PD 2

poePowerMode_Auto 3

poePowerState 2

2 - Power State Option Code

poePowerState_Off 0

poePowerState_PSE 1

poePowerState_PD 2

poePairEnabled 3

3 - Pair Enabled Option Code

poePairSourcingClass 4

4 - Pair Sourcing Class Option Code

poePairSourcingClass_Unknown 0

poePairSourcingClass_0 1

poePairSourcingClass_1 2

poePairSourcingClass_2 3

poePairSourcingClass_3 4

poePairSourcingClass_4 5

poePairSourcingClass_4_PlusType1Limited 6

poePairSourcingClass_5_4PairSingleSignature 7

poePairSourcingClass_5_4PairDualSignature 8

poePairSourcingClass_6_4PairSingleSignature 9

poePairSourcingClass_7_4PairSingleSignature 10

poePairSourcingClass_8_4PairSingleSignature 11

poePairSourcingClass_Mismatch 12

poePairSourcingClass_OverCurrent 13

poePairRequestedClass 5

5 - Pair Requested Class Option Code

poePairRequestedClass_Unknown 0

poePairRequestedClass_0 1

poePairRequestedClass_1 2

poePairRequestedClass_2 3

poePairRequestedClass_3 4

poePairRequestedClass_4 5

poePairRequestedClass_4_PlusType1Limited 6

poePairRequestedClass_5_4PairSingleSignature 7

poePairRequestedClass_5_4PairDualSignature 8

poePairRequestedClass_6_4PairSingleSignature 9

poePairRequestedClass_7_4PairSingleSignature 10

poePairRequestedClass_8_4PairSingleSignature 11

poePairRequestedClass_Mismatch 12

poePairRequestedClass_OverCurrent 13

poePairDiscoveredClass 6

6 - Pair Discovered Class Option Code

poePairDiscoveredClass_Unknown 0

poePairDiscoveredClass_0 1

poePairDiscoveredClass_1 2

poePairDiscoveredClass_2 3

poePairDiscoveredClass_3 4

poePairDiscoveredClass_4 5

poePairDiscoveredClass_4_PlusType1Limited 6

poePairDiscoveredClass_5_4PairSingleSignature 7

poePairDiscoveredClass_5_4PairDualSignature 8

poePairDiscoveredClass_6_4PairSingleSignature 9

poePairDiscoveredClass_7_4PairSingleSignature 10

poePairDiscoveredClass_8_4PairSingleSignature 11

poePairDiscoveredClass_Mismatch 12

poePairDiscoveredClass_OverCurrent 13

poePairDetectionStatus 7

7 - Pair Detection Status Option Code

poePairDetectionStatus_Unknown 0

poePairDetectionStatus_Short_Circuit 1

poePairDetectionStatus_Open_Circuit 2

poePairDetectionStatus_Low_Resistance 3

poePairDetectionStatus_High_Resistance 4

poePairDetectionStatus_Valid 5

poePairDetectionStatus_Switch_Failure 6

poePairVoltage 8

8 - Pair Voltage Option Code

poePairCurrent 9

9 - Pair Current Option Code

poePairPower 10

10 - Pair Power Option Code

poeTotalPower 11

11 - Combined Pair Power Option Code

poePairAccumulatedPower 12

12 - Pair Accumulated Power Option Code

poeTotalAccumulatedPower 13

13 - Combined Pair Accumulated Power Option Code

poePairResistance 14

14 - Pair Resistance Option Code

poePairCapacitance 15

15 - Pair Capacitance Option Code

poeNumberOfOptions 16

16 - Number of Options for POE, always last entry

Pointer Entity

group cmdPOINTER_Defines

Pointer Command defines.

Defines

cmdPOINTER 7

7 - Pointer command code.

group cmdPOINTER_Command_Options

Defines

pointerOffset 1

1 - Offset Option Code

pointerMode 2

2 - Mode Option Code

pointerModeStatic 0

0 - Static Mode

pointerModeIncrement 1

1 - Increment Mode

pointerModeDefault 0

0 - Default Mode

pointerTransferStore 3

3 - Set Transfer Store Option Code

pointerChar 4

4 - Char Option Code

pointerShort 5

5 - Short Option Code

pointerInt 6

6 - Integer Option Code

pointerTransferToStore 7

7 - Transfer to Store Option Code

pointerTransferFromStore 8

8 - Transfer From Store Option Code

Port Entity

group cmdPORT_Defines

Port Command defines.

Defines

cmdPORT 37

37 - Port command code.

group cmdPORT_Command_Options

Defines

portVbusVoltage 1

1 - Vbus Voltage Option Code

portVbusCurrent 2

2 - Vbus Current Option Code

portVconnVoltage 3

3 - Vconn Voltage Option Code

portVconnCurrent 4

4 - Vconn Current Option Code

portPortEnabled 5

5 - Port Enabled Option Code

portPowerEnabled 6

6 - Port Power Enabled Option Code

portDataEnabled 7

7 - Port Data Enabled Option Code

portDataHSEnabled 8

8 - Port HS Data Enabled Option Code

portDataHS1Enabled 9

9 - Port HS1 Data Enabled Option Code

portDataHS2Enabled 10

10 - Port HS2 Data Enabled Option Code

portDataSSEnabled 11

11 - Port SS Data Enabled Option Code

portDataSS1Enabled 12

12 - Port SS1 Data Enabled Option Code

portDataSS2Enabled 13

13 - Port SS2 Data Enabled Option Code

portCCEnabled 14

14 - CC Enabled Option Code

portCC1Enabled 15

15 - CC1 Enabled Option Code

portCC2Enabled 16

16 - CC2 Enabled Option Code

portVconnEnabled 17

17 - Vconn Enabled Option Code

portVconn1Enabled 18

18 - Vconn1 Enabled Option Code

portVconn2Enabled 19

19 - Vconn2 Enabled Option Code

portPortState 20

20 - Port State Option Code

portPortState_powerEnabled_Bit 0

0 - Power enable bit

portPortState_HS1Enabled_Bit 1

1 - USB 2.0 (HS) 1 side enable bit.

portPortState_HS2Enabled_Bit 2

2 - USB 2.0 (HS) 2 side enable bit

portPortState_SS1Enabled_Bit 3

3 - USB 3.0 (SS) 1 side enable bit

portPortState_SS2Enabled_Bit 4

4 - USB 3.0 (SS) 2 side enable bit

portPortState_CC1Enabled_Bit 5

5 - CC 1 enable bit

portPortState_CC2Enabled_Bit 6

6 - CC 2 enable bit

portPortState_Vconn1Enabled_Bit 7

7 - VConn 1 enable bit

portPortState_Vconn2Enabled_Bit 8

8 - VConn 2 enable bit

portPortState_SBU1Enabled_Bit 9

9 - SBU 1 enable bit

portPortState_SBU2Enabled_Bit 10

10 - SBU 2 enable bit

portPortState_CC_Flipped_Bit 11

11 - CC Flipped bit

portPortState_HS_Flipped_Bit 12

12 - HS Flipped bit

portPortState_SS_Flipped_Bit 13

13 - SS Flipped bit

portPortState_SBU_Flipped_Bit 14

14 - SBU Flipped bit

portPortState_KACEnabled_Bit 15

15 - KAC Enabled bit

portErrors 21

21 - Port Errors Option Code

portCurrentLimit 22

22 - Port Current Limit. Option Code

portCurrentLimitMode 23

23 - Port Current Limit Mode. Option Code

portPowerLimit 24

24 - Port Power Limit. Option Code

portPowerLimitMode 25

25 - Port Power Limit Mode. Option Code

portAvailablePower 26

26 - Port available power Option Code

portName 27

27 - Port Name Option Code

portCCCurrentLimit 28

28 - Port CC Current Limit Option Code

portCCCurrentLimit_None 0

0 - None Current value

portCCCurrentLimit_Default 1

1 - Default Current value (500/900mA)

portCCCurrentLimit_1p5 2

2 - 1.5 Amp Current value

portCCCurrentLimit_3p0 3

3 - 3.0 Amp Current value

portPowerMode 30

30 - Port Power mode Option Code

portPowerMode_none_Value 0

0 - None/Disabled

portPowerMode_sdp_Value 1

1 - Standard Downstream Port (SDP)

portPowerMode_cdp_dcp_Value 2

2 - Charging Downstream Port (CDP) or Dedicated Charging Port (DCP)

portPowerMode_qc_Value 3

3 - Qualcom Quick Charge (QC)

portPowerMode_pd_Value 4

4 - Power Delivery (PD)

portPowerMode_ps_Value 5

5 - Power Supply Mode

portPowerMode_usbc_Value 6

6 - USB-C Mode

portDataRole 31

31 - Port Data Role Option Code

portDataRole_Disabled_Value 0

0 - Role - Disabled

portDataRole_Upstream_Value 1

1 - Role - Upstream Port

portDataRole_Downstream_Value 2

2 - Role:Downstream Port

portDataRole_Control_Value 3

3 - Role:Control Port

portDataSpeed 32

32 - Port Data Speed Option Code

portDataSpeed_ls_1p5M_Bit 0

0 - Speed - Low Speed (1.5Mbps) bit indicator

portDataSpeed_fs_12M_Bit 1

1 - Speed - Full Speed (12Mbps) bit indicator

portDataSpeed_hs_480M_Bit 2

2 - Speed - High Speed (480Mbps) bit indicator

portDataSpeed_ss_5G_Bit 3

3 - Speed - Super Speed (5Gbps) bit indicator

portDataSpeed_ss_10G_Bit 4

4 - Speed - Super Speed Plus (10Gbps) bit indicator

portDataSpeed_Connected_2p0_Bit 6

6 - USB 2.0 Connected

portDataSpeed_Connected_3p0_Bit 7

7 - USB 3.0 Connected

portPortMode 33

33 - Port Mode Option Code

portPortMode_powerEnabled_Bit 0

0 - Power enable bit

portPortMode_HS1Enabled_Bit 1

1 - USB 2.0 (HS) 1 side enable bit.

portPortMode_HS2Enabled_Bit 2

2 - USB 2.0 (HS) 2 side enable bit

portPortMode_SS1Enabled_Bit 3

3 - USB 3.0 (SS) 1 side enable bit

portPortMode_SS2Enabled_Bit 4

4 - USB 3.0 (SS) 2 side enable bit

portPortMode_CC1Enabled_Bit 5

5 - CC 1 enable bit

portPortMode_CC2Enabled_Bit 6

6 - CC 2 enable bit

portPortMode_Vconn1Enabled_Bit 7

7 - CC 1 enable bit

portPortMode_Vconn2Enabled_Bit 8

8 - CC 2 enable bit

portPortMode_SBU1Enabled_Bit 9

9 - SBU 1 enable bit

portPortMode_SBU2Enabled_Bit 10

10 - SBU 2 enable bit

portPortMode_HSFlipEnabled_Bit 11

11 - HS Flipped bit

portPortMode_SSFlipEnabled_Bit 12

12 - SS Flipped bit

portPortMode_CCFlipEnabled_Bit 13

13 - CC Flipped bit

portPortMode_SBUFlipEnabled_Bit 14

14 - SBU Flipped bit

portPortMode_KACEnabled_Bit 15

15 - KAC Enabled bit

portPortMode_portPowerMode_Offset 16

16 - Port Power Mode offset within Port Mode

portPortMode_portPowerMode_Mask 0x7

0x7 - Port Power Mode offset (Pre offset shift)

portPortMode_portPowerMode_none_Value 0

0 - Port Power None/Disabled

portPortMode_portPowerMode_sdp_Value 1

1 - Port Power Standard Downstream Port (SDP)

portPortMode_cdp_dcp_Value 2

2 - Charging Downstream Port (CDP) or Dedicated Charging Port (DCP)

portPortMode_portPowerMode_qc_Value 3

3 - Port Power Qualcom Quick Charge (QC)

portPortMode_portPowerMode_pd_Value 4

4 - Port Power Power Delivery (PD)

portPortMode_portPowerMode_ps_Value 5

5 - Port Power Power Supply Mode

portPortMode_portPowerMode_usbc_Value 6

6 - Port Power USB-C Mode

portVoltageSetpoint 34

34 - Port Voltage Setpoint for VBUS Override Option Code

portAllocatedPower 35

35 - Port Allocated Power Option Code

portDataHSRoutingBehavior 36

36 - Port Change HighSpeed Data Signal Routing Behavior Option Code

portDataHSRoutingBehavior_FollowCC 0

0 - Auto Follow CC

portDataHSRoutingBehavior_Side1 1

1 - Side 1 Only

portDataHSRoutingBehavior_Side2 2

2 - Side 2 Only

portDataHSRoutingBehavior_Shorted 3

3 - Side 1 and 2 Shorted

portDataSSRoutingBehavior 37

37 - Port Change SuperSpeed Data Signal Routing Behavior Option Code

portDataSSRoutingBehavior_FollowCC 0

0 - Auto Follow CC

portDataSSRoutingBehavior_Side1 1

1 - Side 1 Only

portDataSSRoutingBehavior_Side2 2

2 - Side 2 Only

portVbusAccumulatedPower 38

38 - Vbus Accumulated Power Option Code

portResetVbusAccumulatedPower 39

39 - Reset Vbus Accumulated power Option Code

portVconnAccumulatedPower 40

40 - Vconn Accumulated Power Option Code

portResetVconnAccumulatedPower 41

41 - Reset Vconn Accumulated power Option Code

portHSBoost 42

42 - Port USB 2.0 High Speed Boost Settings Option Code

portHSBoost_m5Percent 0

0 - -5%

portHSBoost_Nominal 1

1 - Nominal

portHSBoost_p5Percent 2

2 - +5%

portHSBoost_p10Percent 3

3 - +10%

portHSBoost_p15Percent 4

4 - +15%

portHSBoost_p20Percent 5

5 - +20%

portHSBoost_p25Percent 6

6 - +25%

portHSBoost_p30Percent 7

7 - +30%

portResetEntityToFactoryDefaults 44

44 - Port Reset to Factory Defaults Option Code

portCC1State 45

45 - Port CC1 Bias Option Code

portCC1State_None 0

0 - None value

portCC1State_Invalid 1

1 - Invalid value

portCC1State_RpDefault 2

2 - Default (500/900/1500mA) Rp value

portCC1State_Rp1p5 3

3 - 1.5 Amp Rp value

portCC1State_Rp3p0 4

4 - 3.0 Amp Rp value

portCC1State_Rd 5

5 - Rd value

portCC1State_Ra 6

6 - Ra value

portCC1State_Managed 7

7 - Managed by FW

portCC1State_Unknown 8

8 - Unknown

portCC2State 46

46 - Port CC2 State Option Code

portCC2State_None 0

0 - None value

portCC2State_Invalid 1

1 - Invalid value

portCC2State_RpDefault 2

2 - Default (500/900/1500mA) Rp value

portCC2State_Rp1p5 3

3 - 1.5 Amp Rp value

portCC2State_Rp3p0 4

4 - 3.0 Amp Rp value

portCC2State_Rd 5

5 - Rd value

portCC2State_Ra 6

6 - Ra value

portCC2State_Managed 7

7 - Managed by FW

portCC2State_Unknown 8

8 - Unknown

portCC1Voltage 47

47 - CC1 get voltage Option Code

portCC1Current 48

48 - CC1 get current Option Code

portCC2Voltage 49

49 - CC2 get voltage Option Code

portCC2Current 50

50 - CC2 get current Option Code

portSBU1Voltage 51

51 - SBU1 get voltage Option Code

portSBU2Voltage 52

52 - SBU2 get voltage Option Code

portCC1AccumulatedPower 53

53 - CC1 Accumulated Power Option Code

portCC2AccumulatedPower 54

54 - CC2 Accumulated Power Option Code

portNumberOfOptions 55

55 - Number of Options for port, always last entry

Power Delivery Entity

group cmdPOWERDELIVERY_Defines

Power Delivery Command defines.

Defines

cmdPOWERDELIVERY 36

36 - Power Delivery command code.

group cmdPOWERDELIVERY_Command_Options

Defines

powerdeliveryPowerDataObject 1

powerdeliveryPowerDataObjectList 2

powerdeliveryPowerDataObjectEnabled 3

powerdeliveryPowerDataObjectEnabledList 4

powerdeliveryNumberOfPowerDataObjects 5

powerdeliveryRequestDataObject 6

powerdeliveryConnectionState 7

pdConnectionState_None 0

pdConnectionState_Source 1

pdConnectionState_Sink 2

pdConnectionState_PoweredCable 3

pdConnectionState_PoweredCableWithSink 4

pdConnectionState_AudioAccessory 5

pdConnectionState_DebugAccessory 6

powerdeliveryLinkState 8

pdLinkState_linkType_Offset 0

pdLinkState_linkType_Mask 0x7

pdLinkState_linkType_None 0

pdLinkState_linkType_Legacy 1

pdLinkState_linkType_SPR 2

pdLinkState_linkType_EPR 3

pdLinkState_connectionState_Offset 4

pdLinkState_connectionState_Mask 0xF

pdLinkState_connectionState_None 0

pdLinkState_connectionState_Source 1

pdLinkState_connectionState_Sink 2

pdLinkState_connectionState_PoweredCable 3

pdLinkState_connectionState_PoweredCableWithSink 4

pdLinkState_connectionState_AudioAccessory 5

pdLinkState_connectionState_DebugAccessory 6

pdLinkState_powerRole_Offset 8

pdLinkState_powerRole_Mask 0x7

pdLinkState_powerRole_None 0

pdLinkState_powerRole_Source 1

pdLinkState_powerRole_Sink 2

pdLinkState_dataRole_Offset 12

pdLinkState_dataRole_Mask 0x7

pdLinkState_dataRole_None 0

pdLinkState_dataRole_DFP 1

pdLinkState_dataRole_UFP 2

pdLinkState_vconnState_Offset 16

pdLinkState_vconnState_Mask 0x7

pdLinkState_vconnState_Off 0

pdLinkState_vconnState_Source 1

pdLinkState_vconnState_NotSource 2

pdLinkState_specRevision_Offset 20

pdLinkState_specRevision_Mask 0x7

pdLinkState_specRevision_Unknown 0

pdLinkState_specRevision_1 1

pdLinkState_specRevision_2 2

pdLinkState_specRevision_3 3

powerdeliveryAttachTimeElapsed 9

powerdeliveryResetPowerDataObjectToDefault 15

powerdeliveryCableVoltageMax 16

pdCableVoltage_Invalid 0

pdCableVoltage_20VDC 1

pdCableVoltage_30VDC 2

pdCableVoltage_40VDC 3

pdCableVoltage_50VDC 4

powerdeliveryCableCurrentMax 17

pdCableCurrent_Invalid 0

pdCableCurrent_3Amps 1

pdCableCurrent_5Amps 2

powerdeliveryCableSpeedMax 18

pdCableSpeed_Invalid 0

pdCableSpeed_USB2p0 1

pdCableSpeed_USB3p2_Gen1 2

pdCableSpeed_USB3p2_USB4p0_Gen2 3

pdCableSpeed_USB4p0_Gen3 4

pdCableSpeed_USB4p0_Gen4 5

powerdeliveryCableType 19

pdCableType_Invalid 0

pdCableType_Passive 1

pdCableType_Active 2

powerdeliveryCableOrientation 20

pdCableOrientation_Invalid 0

pdCableOrientation_CC1 1

pdCableOrientation_CC2 2

powerdeliveryPowerRoleCapabilities 21

pdPowerRoleCapabilities_None 0

pdPowerRoleCapabilities_Source 1

pdPowerRoleCapabilities_Sink 2

pdPowerRoleCapabilities_DualRole 3

powerdeliveryPowerRole 22

pdPowerRole_None 0

pdPowerRole_Source 1

pdPowerRole_Sink 2

pdPowerRole_SourceSink 3

powerdeliveryPowerRolePreferred 23

pdPowerRolePreferred_None 0

pdPowerRolePreferred_Source 1

pdPowerRolePreferred_Sink 2

pdPowerRolePreferred_FollowData 3

pdPowerRolePreferred_Auto 4

powerdeliveryPeakCurrentConfiguration 24

powerdeliveryFastRoleSwapCurrent 25

powerdeliveryDataRoleCapabilities 26

pdDataRoleCapabilities_None 0

pdDataRoleCapabilities_DFP 1

pdDataRoleCapabilities_UFP 2

pdDataRoleCapabilities_DualRole 3

powerdeliveryOverride 41

pdOverrideCableCurrent 0

pdOverridePortPower 1

pdOverrideAutoDiscovery 2

powerdeliveryRequestCommand 42

pdRequestHardReset 0

pdRequestSoftReset 1

pdRequestDataReset 2

pdRequestPowerRoleSwap 3

pdRequestPowerFastRoleSwap 4

pdRequestDataRoleSwap 5

pdRequestVconnSwap 6

pdRequestSinkGoToMinimum 7

pdRequestRemoteSourcePowerDataObjects 8

pdRequestRemoteSinkPowerDataObjects 9

pdRequestRemoteSourceExtendedCapabilities 10

pdRequestRemoteSinkExtendedCapabilities 11

pdRequestStatus 12

pdRequestPPSStatus 13

pdRequestBatteryCapabilities 14

pdRequestBatteryStatus 15

pdRequestManufacturerInfoSop 16

pdRequestManufacturerInfoSopp 17

pdRequestManufacturerInfoSoppp 18

pdRequestDiscoverIdentitySop 19

pdRequestDiscoverIdentitySopp 20

pdRequestDiscoverIdentitySoppp 21

pdRequestRevision 22

pdRequestSourceInfo 23

pdRequestCountryCode 24

pdRequestCountryInfo 25

pdRequestRemoteSourceEPRCapabilities 26

pdRequestRemoteSinkEPRCapabilities 27

powerdeliveryRequestStatus 43

powerdeliveryFlagMode 44

pdFlagDualRoleData 1

pdFlagDualRolePower 2

pdFlagUnconstrainedPower 3

pdFlagSuspendPossible 4

pdFlagUSBComPossible 5

pdFlagUnchunkedMessageSupport 6

pdFlagHigherCapability 7

pdFlagCapabilityMismatch 8

pdFlagGivebackFlag 9

pdFlagLast 10

powerdeliveryLogEnable 45

powerdeliveryLogPacket 46

powerdeliveryLogEvent 47

pdEventNone 0

pdEventPacket 1

pdEventConnect 2

pdEventDisconnect 3

pdEventCableResetReceived 4

pdEventCableResetSent 5

pdEventHardResetReceived 6

pdEventHardResetSent 7

pdEventMessageTransmitFailed 8

pdEventMessageTransmitDiscarded 9

pdEventPDFunctionDisabled 10

pdEventVBUSEnabled 11

pdEventVBUSDisabled 12

pdEventVCONNEnabled 13

pdEventVCONNDisabled 14

pdEventRp1A5 15

pdEventRp3A0 16

pdEventBistEnter 17

pdEventBistExit 18

pdEventInvalidPacket 19

pdEventLast 20

powerdeliveryVDM 48

powerdeliveryNumberOfOptions 55

group cmdPOWERDELIVERY_Command_Constants

Defines

powerdeliveryPartnerLocal 0

powerdeliveryPartnerRemote 1

powerdeliveryPowerRoleDisabled 0

powerdeliveryPowerRoleSource 1

powerdeliveryPowerRoleSink 2

powerdeliveryPowerRoleSourceSink 3

powerDeliveryRequestStatus 43

Backwards compatibility for powerDeliveryRequestStatus.

Rail Entity

group cmdRAIL_Defines

Rail Command defines.

Defines

cmdRAIL 32

32 - Rail command code.

group cmdRAIL_Command_Options

Defines

railVoltage 1

1 - Rail Voltage Option Code

railCurrent 2

2 - Rail Current Option Code

railCurrentLimit 3

3 - Rail Current limit Option Code

railTemperature 4

4 - Rail Temperature Option Code

railEnable 5

5 - Rail Enable Option Code

railValue 6

6 - Rail Value Option Code

railKelvinSensingEnable 7

7 - Rail Kelvin sensing Mode Option Code

kelvinSensingOff_Value 0

0 - Kelvin Sensing off mode for Kelvin Sensing mode

kelvinSensingOn_Value 1

1 - Kelvin Sensing on mode for Kelvin Sensing mode

railKelvinSensingState 8

8 - Kelving Sensing state Option Code

railOperationalMode 9

9 - Operational Mode Option Code

railOperationalMode_HardwareConfiguration_Offset 0

0 - Operational Mode hardware configuration offset region (bits[0:3])

railOperationalModeAuto_Value 0

0 - Auto operational mode for operational mode

railOperationalModeLinear_Value 1

1 - Linear mode for operational mode

railOperationalModeSwitcher_Value 2

2 - Switcher mode for operational mode

railOperationalModeSwitcherLinear_Value 3

3 - Switcher Linear mode for operational mode

railOperationalMode_Mode_Offset 4

4 - Operational Mode offset region (bits[4:7])

railOperationalModeConstantCurrent_Value 0

0 - Constant Current mode for operational mode

railOperationalModeConstantVoltage_Value 1

1 - Constant Voltage mode for operational mode

railOperationalModeConstantPower_Value 2

2 - Constant Power mode for operational mode

railOperationalModeConstantResistance_Value 3

3 - Constant Resistance mode for operational mode

railOperationalModeFactoryReserved_Value 0xF

0xF - Factory Reserved Operating Mode.

DefaultOperationalRailMode_Value 0

0 - Default operational mode for operational mode

railOperationalState 10

10 - Operational state Option Code

railOperationalState_Initializing_Bit 0

0 - Initializing bit for operational state

railOperationalState_Enabled_Bit 1

1 - Enabled bit for operational state

railOperationalState_Fault_Bit 2

2 - Fault bit for operational state

railOperationalState_HardwareConfiguration_Offset 8

8 - Hardware Configuration region (bits[8-15]) for operational state.

railOperationalStateLinear_Value 0

0 - Linear state for operational state option mode.

railOperationalStateSwitcher_Value 1

1 - Switcher state for operational state option mode.

railOperationalStateSwitcherLinear_Value 2

2 - Switcher Linear state for operational state option mode.

railOperationalStateOverVoltageFault_Bit 16

16 - Over Voltage Fault bit for operational state option mode.

railOperationalStateUnderVoltageFault_Bit 17

17 - Under Voltage Fault bit for operational state option mode.

railOperationalStateOverCurrentFault_Bit 18

18 - Over Current Fault bit for operational state option mode.

railOperationalStateOverPowerFault_Bit 19

19 - Over Power Fault bit for operational state option mode.

railOperationalStateReversePolarityFault_Bit 20

20 - Reverse Polarity Fault bit for operational state option mode.

railOperationalStateOverTemperatureFault_Bit 21

21 - Over Temperature Fault bit for operational state option mode.

railOperationalStateReverseCurrentFault_Bit 22

22 - Reverse Current Fault bit for operational state option mode.

railOperationalStateOperatingMode_Offset 24

24 - Operating Mode region (bits[24:31]) for operational state.

railOperationalStateConstantCurrent_Value 0

0 - Constant Current mode for operational state

railOperationalStateConstantVoltage_Value 1

1 - Constant Voltage mode for operational state

railOperationalStateConstantPower_Value 2

2 - Constant Power mode for operational state option codes.

railOperationalStateConstantResistance_Value 3

3 - Constant Resistance mode for operational state

railVoltageSetpoint 11

11 - Rail Setpoint Voltage option code

railCurrentSetpoint 12

12 - Rail Setpoint Current Option Code

railVoltageMinLimit 13

13 - Rail Voltage min limit Option Code

railVoltageMaxLimit 14

14 - Rail Voltage max limit Option Code

railPower 15

15 - Rail power Option Code

railPowerSetpoint 16

16 - Rail Setpoint power Option Code

railPowerLimit 17

17 - Rail power limit Option Code

railResistance 18

18 - Rail resistance Option Code

railResistanceSetpoint 19

19 - Rail Setpoint resistance Option Code

railClearFaults 20

20 - Rail Clear Fault Codes. Option Code

railNumberOfOptions 21

21 - Number of Options for Rail, always last entry

group cmdRAIL_Command_Constants

Defines

railFactoryReserved 62

Factory Reserved Code.

railFactoryReserved2 63

Factory Reserved Code.

Relay Entity

group cmdRELAY_Defines

Relay Command defines.

Defines

cmdRELAY 34

34 - Relay command code.

group cmdRELAY_Command_Options

Defines

relayEnable 1

1 - Enable Option Code

relayVoltage 2

2 - Voltage Option Code

relayNumberOfOptions 3

3 - Number of Options for relay, always last entry

RCServo Entity

group cmdSERVO_Defines

RCServo Command defines.

Defines

cmdSERVO 13

13 - RCServo command code.

group cmdSERVO_Command_Options

Defines

servoEnable 1

1 - Enable Option Code

servoPosition 2

2 - Position Option Code

servoReverse 3

3 - Reverse Option Code

servoNumberOfOptions 4

4 - Number of Options for servo, always last entry

Signal Entity

group cmdSIGNAL_Defines

Signal Command defines.

Defines

cmdSIGNAL 14

14 - Signal command code.

group cmdSIGNAL_Command_Options

Defines

signalEnable 1

1 - Enable Option Code

signalInvert 2

2 - Inversion of Duty Cycle Option Code

signalT3Time 3

3 - Period Option Code

signalT2Time 4

4 - Active Time Option Code

signalNumberOfOptions 5

5 - Number of Options for signal, always last entry

Slot Entity

group cmdSLOT_Defines

Slot Command defines.

Defines

cmdSLOT 4

4 - Slot command code.

group cmdSLOT_Command_Options

Defines

slotCapacity 1

1 - Capacity Option Code

slotSize 2

2 - Size Option Code

slotOpenRead 3

3 - Open Read Only Option Code

slotOpenWrite 4

4 - Open Read Write Option Code

slotSeek 5

5 - Seek Option Code

slotRead 6

6 - Read Option Code

slotWrite 7

7 - Write Option Code

slotClose 8

8 - Close Option Code

slotNumberOfOptions 9

9 - Number of Options for slot, always last entry

group cmdSLOT_Command_Constants

Defines

bitSlotError 0x80

Bit Slot Error.

Store Entity

group cmdSTORE_Defines

Store Command defines.

Defines

cmdSTORE 77

77 - Store command code.

group cmdSTORE_Command_Options

Defines

storeSlotEnable 1

1 - Slot Enable Option Code

storeSlotDisable 2

2 - Slot Disable Option Code

storeSlotState 3

3 - Slot State Option Code

storeWriteSlot 4

4 - Slot Write Option Code

storeReadSlot 5

5 - Slot Read Option Code

storeCloseSlot 6

6 - Slot Close Option Code

storeLock 7

7 - Slot Lock Option Code

storeNumberOfOptions 8

8 - Number of Options for store, always last entry

group cmdSTORE_Command_Constants

Defines

storeInternalStore 0

Internal Store Type.

storeRAMStore 1

RAM Store Type.

storeSDStore 2

SD Store Type.

storeEEPROMStore 3

EEPROM Store Type.

storeMaxStoreIndex 3

Maximum Store Type Index.

Stream Entity

group cmdSTREAM_Defines

Stream Command defines.

Defines

cmdSTREAM 93

93 - Stream command code.

group cmdSTREAM_Command_Options

Defines

streamEnable 1

1 - Enable Stream Key Option Code

streamDisable 2

2 - Disable Stream Key Option Code

streamCapacity 3

3 - Stream Key Capacity Option Code

streamNumberOfOptions 4

4 - Number of Options for stream, always last entry

System Entity

group cmdSYSTEM_Defines

System Command defines.

Defines

cmdSYSTEM 3

3 - System command code.

group cmdSYSTEM_Command_Options

Defines

systemModule 1

1 - Module address Option Code

systemRouter 2

2 - Router address Option Code

systemHBInterval 3

3 - Heartbeat interval Option Code

systemLED 4

4 - User LED Option Code

systemSleep 5

5 - Sleep Option Code

systemBootSlot 6

6 - Boot Slot Option Code

aSystemBootSlotNone 255

255 - Disable boot slot value for Boot Slot option.

systemVersion 7

7 - Firmware Version Option Code

systemModel 8

8 - Model Option Code

systemSerialNumber 9

9 - Serial Number Option Code

systemSave 10

10 - System save Option Code

systemReset 11

11 - System reset Option Code

systemInputVoltage 12

12 - Input voltage Option Code

systemModuleHardwareOffset 13

13 - Module Offset Option Code

systemModuleBaseAddress 14

14 - Module Base address Option Code

systemModuleSoftwareOffset 15

15 - Module Software offset Option Code

systemRouterAddressSetting 16

16 - Router address setting Option Code

systemIPConfiguration 17

17 - IP configuration setting option code

systemIPModeDHCP 0

0 - DHCP Configuration

systemIPModeStatic 1

1 - Static Configuration

systemIPModeDefault 0

0 - Default Configuration

systemIPAddress 18

18 - IP address setting option code

systemIPStaticAddressSetting 19

19 - Static IP address setting option code

systemRouteToMe 20

20 - Route to me setting option code

systemInputCurrent 21

21 - Input current Option Code

systemUptime 22

22 - System uptime Option Code

systemMaxTemperature 23

23 - System max temperature Option Code

systemLogEvents 24

24 - System log events Option Code

systemUnregulatedVoltage 25

25 - Unregulated System Voltage Option Code

systemUnregulatedCurrent 26

26 - Unregulated System Current Option Code

systemTemperature 27

27 - System temperature option code

systemMinTemperature 28

28 - System min temperature option code

systemInputPowerSource 29

29 - System input power source option code

systemInputPowerBehavior 30

30 - System input power behavior option code

systemInputPowerBehaviorConfig 31

31 - System input power behavior config option code

systemName 32

32 - System name option code

systemPowerLimit 33

33 - System power limit option code

systemPowerLimitMax 34

34 - System power limit max option code

systemPowerLimitState 35

35 - System power limit state option code

systemResetEntityToFactoryDefaults 36

systemResetDeviceToFactoryDefaults 37

systemLinkInterface 38

38 - Setting the link interface for control Option Code

systemLinkAuto 0

0 - System Link is automatically defined

systemLinkUSBControl 1

1 - System Link through control port

systemLinkUSBHub 2

2 - System Link through the Hub (upstream connection)

systemLinkUSBAll 3

3 - System Link through the all available connections

systemReserved 39

39 - Reserved Option Code for Acroname Internal Use Only Option Code

systemHardwareVersion 40

40 - Hardware Version option code

systemErrors 41

41 - System Error option code

systemErrors_ThermalProtection_Bit 0

0 - Thermal Protection bit for operational Errors

systemErrors_OutputPowerProtection_Bit 1

1 - Output Power Protection bit for operational Errors

systemLEDMaxBrightness 42

42 - System LED Brightness option code

systemBuild 43

43 - Firmware build option code

systemProtocolFeatures 45

45 - Firmware protocol features Option Code

systemProtocolFeatures_pooledPackets_Bit 31

31 - Defines bit if the protocol supports pooling of brainstem packets into a single USB frame.

systemNumberOfOptions 46

46 - Number of Options for System, always last entry

Temperature Entity

group cmdTEMPERATURE_Defines

Temperature Command defines.

Defines

cmdTEMPERATURE 33

33 - Temperature command code.

group cmdTEMPERATURE_Command_Options

Defines

temperatureMicroCelsius 1

1 - Temperature Value Option Code

temperatureMinimumMicroCelsius 2

2 - Minimum Recorded Temperature Option Code

temperatureMaximumMicroCelsius 3

3 - Maximum Recorded Temperature Option Code

temperatureResetLoggedValues 4

4 - Temperature Logged Value reset option code

temperatureNumberOfOptions 5

5 - Number of Options for temperature, always last entry

Timer Entity

group cmdTIMER_Defines

Timer Command defines.

Defines

cmdTIMER 79

79 - Timer command code.

group cmdTIMER_Command_Options

Defines

timerExpiration 1

1 - Expiration Value Option Code

timerMode 2

2 - Mode Option Code

timerModeSingle 0

0 - Single Shot Mode

timerModeRepeat 1

1 - Repeated Mode

DefaultTimerMode 0

0 - Default Mode

timerNumberOfOptions 3

3 - Number of Options for timer, always last entry

UART Entity

group cmdUART_Defines

UART Command defines.

Defines

cmdUART 35

35 - UART command code.

group cmdUART_Command_Options

Defines

uartEnable 1

1 - Enable Option Code

uartBaudRate 2

2 - Baud Rate Option Code

uartBaudRate_Auto_Value 0

0 - Automatically Selected Baud Rate

uartProtocol 3

3 - Protocol Option Code

uartProtocol_Undefined 0

0 - Not Yet Defined Protocol

uartProtocol_Extron_Value 1

1 - Extron Responder (backward compatiblity)

uartProtocol_ExtronResponder_Value 1

1 - Extron Responder

uartProtocol_Brainstem_Value 2

2 - Brainstem Transport

uartProtocol_ExtronInitiator_Value 3

3 - Extron Initator

uartProtocol_Reserved4_Value 4

4 - Reserved

uartProtocol_Reserved5_Value 5

5 - Reserved

uartProtocol_Loopback_Value 6

6 - Loopback

uartLinkChannel 4

4 - UART Linked Channel Option Code

uartStopBits 5

5 - UART Stop Bits Option Code

uartStopBits_1_Value 0

0 - 1 Stop Bit

uartStopBits_1p5_Value 1

1 - 1.5 Stop Bits

uartStopBits_2_Value 2

2 - 2 Stop Bits

uartParity 6

6 - UART Parity Option Code

uartParity_None_Value 0

0 - No Parity Bit

uartParity_Odd_Value 1

1 - Odd Parity Bit

uartParity_Even_Value 2

2 - Even Parity Bit

uartParity_Mark_Value 3

3 - Mark Parity Bit

uartParity_Space_Value 4

4 - Space Parity Bit

uartDataBits 7

7 - UART Data Bits per Character Option Code

uartFlowControl 8

8 - UART Flow Control Option Code

uartFlowControl_RTS_CTS_Bit 0

0 - RTS/CTS Enable

uartFlowControl_DSR_DTR_Bit 1

1 - DSR/DTR Enable

uartFlowControl_XON_XOFF_Bit 2

2 - XON/XOFF Enable

uartCapableProtocols 9

9 - Option Code for UART Capable Protocols

uartAvailableProtocols 10

10 - Option Code for UART Available Protocols

uartNumberOfOptions 11

11 - Number of Options for UART, always last entry

USB Entity

group cmdUSB_Defines

USB Command defines.

Defines

cmdUSB 18

18 - USB command code.

group cmdUSB_Command_Options

Defines

usbPortEnable 1

1 - Port Enable Option Code

usbPortDisable 2

2 - Port Disable Option Code

usbDataEnable 3

3 - Data Enable Option Code

usbDataDisable 4

4 - Data Disable Option Code

usbPowerEnable 5

5 - Power Enable Option Code

usbPowerDisable 6

6 - Power Disable Option Code

usbPortCurrent 7

7 - Port Current Option Code

usbPortVoltage 8

8 - Port Voltage Option Code

usbHubMode 9

9 - Hub Mode Option Code

usbPortClearErrorStatus 12

12 - Hub Clear Error Status Option Code

usbUpstreamMode 14

14 - Upstream Mode Option Code

usbUpstreamModeAuto 2

2 - UpstreamMode Auto for upstream mode

usbUpstreamModePort0 0

0 - UpstreamMode Port 0 for upstream mode

usbUpstreamModePort1 1

1 - UpstreamMode Port 1 for upstream mode

usbUpstreamModeNone 255

255 - UpstreamMode None to turn off all upstream connections.

usbUpstreamModeDefault 2

2 - UpstreamMode default for upstream mode

usbUpstreamState 15

15 - UpstreamState Option Code

usbUpstreamStateNone 2

2 - UpstreamMode Auto for upstream mode

usbUpstreamStatePort0 0

0 - UpstreamMode Port 0 for upstream mode

usbUpstreamStatePort1 1

1 - UpstreamMode Port 1 for upstream mode

usbHubEnumerationDelay 16

16 - Downstream ports enumeration delay Option Code

usbPortCurrentLimit 17

17 - Set or get the port current limit Option Code

usbUpstreamBoostMode 18

18 - Set/Get upstream boost mode. Option Code

usbDownstreamBoostMode 19

19 - Set/Get downstream boost mode. Option Code

usbBoostMode_0 0

0 - Boost mode off, no boost.

usbBoostMode_4 1

1 - Boost mode 4%.

usbBoostMode_8 2

2 - Boost mode 8%.

usbBoostMode_12 3

3 - Boost mode 12%.

usbPortMode 20

20 - Set/Get Port mode (bit-packed) Option Code

usbPortMode_sdp 0

0 - Standard Downstream port (0.5 Amp).

usbPortMode_cdp 1

1 - Charging Downstream port (2.1 Amp).

usbPortMode_charging 2

2 - Trickle changing functionality.

usbPortMode_passive 3

3 - Electrical pasthrough of VBUS.

usbPortMode_USB2AEnable 4

4 - USB2 dataline A side enabled.

usbPortMode_USB2BEnable 5

5 - USB2 dataline B side enabled.

usbPortMode_VBusEnable 6

6 - USB VBUS enabled.

usbPortMode_SuperSpeed1Enable 7

7 - USB SS Speed dataline side A enabled.

usbPortMode_SuperSpeed2Enable 8

8 - USB SS Speed dataline side B enabled.

usbPortMode_USB2BoostEnable 9

9 - USB2 Boost Mode Enabled.

usbPortMode_USB3BoostEnable 10

10 - USB3 Boost Mode Enabled.

usbPortMode_AutoConnectEnable 11

11 - Auto-connect Mode Enabled.

usbPortMode_CC1Enable 12

12 - CC1 Enabled.

usbPortMode_CC2Enable 13

13 - CC2 Enabled.

usbPortMode_SBUEnable 14

14 - SBU1 Enabled.

usbPortMode_CCFlipEnable 15

15 - Flip CC1 and CC2.

usbPortMode_SSFlipEnable 16

16 - Flip Super speed data lines

usbPortMode_SBUFlipEnable 17

17 - Flip Side Band Unit lines.

usbPortMode_USB2FlipEnable 18

18 - Flip Side Band Unit lines.

usbPortMode_CC1InjectEnable 19

19 - Internal Use.

usbPortMode_CC2InjectEnable 20

20 - Internal Use.

usbHiSpeedDataEnable 21

21 - Hi-Speed Data Enable Option Code

usbHiSpeedDataDisable 22

22 - Hi-Speed Data Disable Option Code

usbSuperSpeedDataEnable 23

23 - SuperSpeed Data Enable Option Code

usbSuperSpeedDataDisable 24

24 - SuperSpeed Data Disable Option Code

usbDownstreamDataSpeed 25

25 - Get downstream port speed Option Code

usbDownstreamDataSpeed_na 0

0 - Unknown.

usbDownstreamDataSpeed_hs 1

1 - Hi-Speed (2.0).

usbDownstreamDataSpeed_ss 2

2 - SuperSpeed (3.0).

usbDownstreamDataSpeed_ls 3

3 - TODO

usbConnectMode 26

26 - USB connect mode Option Code

usbManualConnect 0

0 - Auto connect disabled.

usbAutoConnect 1

1 - Auto connect enabled.

usbCC1Enable 27

27 - CC1 Enable option code (USB Type C). Option Code

usbCC2Enable 28

28 - CC2 Disable option code (USB Type C). Option Code

usbSBUEnable 29

29 - SBU1/2 enable option code (USB Type C). Option Code

usbCC1Current 30

30 - CC1 get current option code (USB Type C). Option Code

usbCC2Current 31

31 - CC2 get current option code (USB Type C). Option Code

usbCC1Voltage 32

32 - CC1 get voltage option code (USB Type C). Option Code

usbCC2Voltage 33

33 - CC2 get voltage option code (USB Type C). Option Code

usbPortState 34

34 - TODO Option Code

usbPortError 35

35 - TODO Option Code

usbCableFlip 36

36 - TODO Option Code

usbAltMode 37

37 - USB Alt Mode configuration. Option Code

usbAltMode_disabled 0

0 - Disabled mode.

usbAltMode_normal 1

1 - Normal mode (USB 3.1).

usbAltMode_4LaneDP_ComToHost 2

2 - Alt Mode - 4 lanes of display port “Common” side connected to host.

usbAltMode_4LaneDP_MuxToHost 3

3 - Alt Mode - 4 lanes of display port “Mux” side connected to host.

usbAltMode_2LaneDP_ComToHost_wUSB3 4

4 - Alt Mode - 2 lanes of display port “Common” side connected to host with USB3.1.

usbAltMode_2LaneDP_MuxToHost_wUSB3 5

5 - Alt Mode - 2 lanes of display port “Mux” side connected to host with USB3.1.

usbAltMode_2LaneDP_ComToHost_wUSB3_Inverted 6

6 - Alt Mode - 2 lanes of display port “Common” side connected to host with USB3.1 with channels 1.2 and 3,4 inverted.

usbAltMode_2LaneDP_MuxToHost_wUSB3_Inverted 7

7 - Alt Mode - 2 lanes of display port “Mux” side connected to host with USB3.1 with channels 1.2 and 3,4 inverted.

usbAltMode_USB4_ComToHost 8

8 - Alt Mode - USB4 with “Common” side connected to host.

usbAltMode_USB4_MuxToHost 9

9 - Alt Mode - USB4 with “Mux” side connected to host.

usbAltMode_USB4_ComToHost_Inverted 10

10 - Alt Mode - USB4 with “Common” side connected to host, inverted configuration

usbAltMode_USB4_MuxToHost_Inverted 11

11 - Alt Mode - USB4 with “Mux” side connected to host, inverted configuration

usbSBU1Voltage 38

38 - SBU1 get voltage option code (USB Type C). Option Code

usbSBU2Voltage 39

39 - SBU2 get voltage option code (USB Type C). Option Code

usbNumberOfOptions 40

40 - Number of Options for USB, always last entry. Option Code

USB System Entity

group cmdUSBSYSTEM_Defines

USB System Command defines.

Defines

cmdUSBSYSTEM 38

38 - USB System command code.

group cmdUSBSYSTEM_Command_Options

Defines

usbsystemPowerDataMode 1

1 - Power and Data Mode option code

usbsystemUpstreamPort 2

2 - Upstream Port option code (default port is 0) Option Code

usbsystemUpstreamPortNone 255

255 - UpstreamPort None to turn off all upstream connections or invalid state.

usbsystemEnumerationDelay 3

3 - Enumeration Delay option code

usbsystemDataRoleList 4

4 - Data Role List option code

usbsystemEnabledList 5

5 - Enabled List option code

usbsystemModeList 6

6 - Mode List option code

usbsystemStateList 7

7 - State List option code

usbsystemPowerBehavior 8

8 - Power behavior option code

usbsystemPowerBehavior_Balancing 0

0 - usbsystemPowerBehavior - Balancing between active ports

usbsystemPowerBehavior_Even 1

1 - usbsystemPowerBehavior - Even between all ports

usbsystemPowerBehaviorConfig 9

9 - Power behavior config option code

usbsystemDataBehavior 10

10 - Data behavior option code

usbsystemDataBehavior_HardCoded 0

0 - usbsystemDataBehavior - HardCoded ports

usbsystemDataBehavior_FollowPD 1

1 - usbsystemDataBehavior - FollowPD

usbsystemDataBehavior_PortPriority 2

2 - usbsystemDataBehavior - Use port priority

usbsystemDataBehavior_LastConnected 3

3 - usbsystemDataBehavior - Most Recently Connected Upstream

usbsystemDataBehaviorConfig 11

11 - Data behavior config option code

usbsystemSelectorMode 12

12 - Selector mode option code

usbsystemSelectorMode_Disabled 0

0 - Selector Disabled

usbsystemSelectorMode_Upstream 1

1 - Selector Upstream - Toggles through upstreams

usbsystemSelectorMode_Mux 2

2 - Selector Mux - Toggles through mux ports

usbsystemResetEntityToFactoryDefaults 13

13 - Resets USBSystem reset to default option code.

usbsystemOverride 14

14 - Behavior overrides for USB System Option Code

usbsystemOverride_AutoVbusToggle_Bit 0

0 - USB System Override - Auto VBUS Toggle Disable Bit

usbsystemOverride_VbusDetect_Bit 1

1 - USB System Override - VBUS Detect Disable Bit

usbsystemUpstreamHSPort 15

15 - Upstream Port option code (default port is 0) Option Code

usbsystemUpstreamSSPort 16

16 - Upstream Port option code (default port is 0) Option Code

usbsystemDataHSMaxDatarate 17

17 - Max HighSpeed Data Rate that can be negotiated Option Code

usbsystemDataHSMaxDatarate_None 0

0 - Max HighSpeed Data Rate of None 0Mbps

usbsystemDataHSMaxDatarate_LowSpeed 1

1 - Max HighSpeed Data Rate of Low Speed 1.5Mbps

usbsystemDataHSMaxDatarate_FullSpeed 2

2 - Max HighSpeed Data Rate of Full Speed 12Mbps

usbsystemDataHSMaxDatarate_HighSpeed 3

3 - Max HighSpeed Data Rate of High Speed 480Mbps

usbsystemDataSSMaxDatarate 18

18 - Max SuperSpeed Data Rate that can be negotiated Option Code

usbsystemDataSSMaxDatarate_None 0

0 - Max SuperSpeed Data Rate of None 0Gbps

usbsystemDataSSMaxDatarate_SuperSpeed 1

1 - Max SuperSpeed Data Rate of Super Speed 5Gbps (Gen 1)

usbsystemDataSSMaxDatarate_SuperSpeedPlus 2

2 - Max SuperSpeed Data Rate of Super Speed 10Gbps (Gen 2)

usbsystemNumberOfOptions 19

19 - Number of Options for USB System, always last entry

UserConfig Entity

group cmdUSERCONFIG_Defines

UserConfig Command defines.

Defines

cmdUSERCONFIG 92

92 - UserConfig command code.

group cmdUSERCONFIG_Command_Options

Defines

userconfigSaveEntityToStore 0

0 - Save Entity option code.

userconfigResetEntityToFactoryDefaults 1

1 - Reset Entity to factory defaults option code.

userconfigLoadEntityFromStore 2

2 - Load Entity from saved values option code.

userconfigNumberOfOptions 3

3 - Number of Options for UserConfig, always last entry