USB Entity

group USBEntity

USBClass: The USB class provides methods to interact with a USB hub and USB switches. Different USB hub products have varying support; check the datasheet to understand the capabilities of each product.

void usb_setPortEnable(unsigned int *id, struct Result *result, const unsigned char channel)

Enable both power and data lines for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_setPortDisable(unsigned int *id, struct Result *result, const unsigned char channel)

Disable both power and data lines for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_setDataEnable(unsigned int *id, struct Result *result, const unsigned char channel)

Enable the only the data lines for a port without changing the state of the power line.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_setDataDisable(unsigned int *id, struct Result *result, const unsigned char channel)

Disable only the data lines for a port without changing the state of the power line.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_setHiSpeedDataEnable(unsigned int *id, struct Result *result, const unsigned char channel)

Enable the only the data lines for a port without changing the state of the power line, Hi-Speed (2.0) only.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_setHiSpeedDataDisable(unsigned int *id, struct Result *result, const unsigned char channel)

Disable only the data lines for a port without changing the state of the power line, Hi-Speed (2.0) only.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_setSuperSpeedDataEnable(unsigned int *id, struct Result *result, const unsigned char channel)

Enable the only the data lines for a port without changing the state of the power line, SuperSpeed (3.0) only.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_setSuperSpeedDataDisable(unsigned int *id, struct Result *result, const unsigned char channel)

Disable only the data lines for a port without changing the state of the power line, SuperSpeed (3.0) only.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_setPowerEnable(unsigned int *id, struct Result *result, const unsigned char channel)

Enable only the power line for a port without changing the state of the data lines.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_setPowerDisable(unsigned int *id, struct Result *result, const unsigned char channel)

Disable only the power line for a port without changing the state of the data lines.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The USB sub channel.

Returns:

Returns common entity return values

void usb_getPortCurrent(unsigned int *id, struct Result *result, const unsigned char channel)

Get the current through the power line for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • microamps – The USB channel current in micro-amps (1 == 1e-6A).

Returns:

Returns common entity return values

void usb_getPortVoltage(unsigned int *id, struct Result *result, const unsigned char channel)

Get the voltage on the power line for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • microvolts – The USB channel voltage in microvolts (1 == 1e-6V).

Returns:

Returns common entity return values

void usb_getHubMode(unsigned int *id, struct Result *result)

Get a bit mapped representation of the hubs mode; see the product datasheet for mode mapping and meaning.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void usb_setHubMode(unsigned int *id, struct Result *result, const unsigned int mode)

Set a bit mapped hub state; see the product datasheet for state mapping and meaning.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • mode – The USB hub mode.

Returns:

Returns common entity return values

void usb_clearPortErrorStatus(unsigned int *id, struct Result *result, const unsigned char channel)

Clear the error status for the given port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • channel – The port to clear error status for.

Returns:

Returns common entity return values

void usb_getUpstreamMode(unsigned int *id, struct Result *result)

Get the upstream switch mode for the USB upstream ports. Returns auto, port 0 or port 1.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void usb_setUpstreamMode(unsigned int *id, struct Result *result, const unsigned char mode)

Set the upstream switch mode for the USB upstream ports. Values are usbUpstreamModeAuto, usbUpstreamModePort0, usbUpstreamModePort1, and usbUpstreamModeNone.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • mode – The Upstream port mode.

Returns:

Returns common entity return values

void usb_getUpstreamState(unsigned int *id, struct Result *result)

Get the upstream switch state for the USB upstream ports. Returns 2 if no ports plugged in, 0 if the mode is set correctly and a cable is plugged into port 0, and 1 if the mode is set correctly and a cable is plugged into port 1.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void usb_setEnumerationDelay(unsigned int *id, struct Result *result, const unsigned int ms_delay)

Set the inter-port enumeration delay in milliseconds.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • ms_delay – Millisecond delay in 100mS increments (100, 200, 300 etc.)

Returns:

Returns common entity return values

void usb_getEnumerationDelay(unsigned int *id, struct Result *result)

Get the inter-port enumeration delay in milliseconds.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void usb_setPortCurrentLimit(unsigned int *id, struct Result *result, const unsigned char channel, const unsigned int microamps)

Set the current limit for the port. If the set limit is not achievable, devices will round down to the nearest available current limit setting. This setting can be saved with a stem.system.save() call.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • channel – USB downstream channel to limit.

  • microamps – The current limit setting.

Returns:

Returns common entity return values

void usb_getPortCurrentLimit(unsigned int *id, struct Result *result, const unsigned char channel)

Get the current limit for the port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • microamps – The current limit setting.

Returns:

Returns common entity return values

void usb_setPortMode(unsigned int *id, struct Result *result, const unsigned char channel, const unsigned int mode)

Set the mode for the Port. The mode is a bitmapped representation of the capabilities of the usb port. These capabilities change for each of the BrainStem devices which implement the usb entity. See your device reference page for a complete list of capabilities. Some devices use a common bit mapping for port mode at usbPortMode

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • channel – USB downstream channel to set the mode on.

  • mode – The port mode setting as packed bit field.

Returns:

Returns common entity return values

void usb_getPortMode(unsigned int *id, struct Result *result, const unsigned char channel)

Get the current mode for the Port. The mode is a bitmapped representation of the capabilities of the usb port. These capabilities change for each of the BrainStem devices which implement the usb entity. See your device reference page for a complete list of capabilities. Some devices implement a common bit mapping for port mode at usbPortMode

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • mode – The port mode setting. Mode will be filled with the current setting. Mode bits that are not used will be marked as don’t care

Returns:

Returns common entity return values

void usb_getPortState(unsigned int *id, struct Result *result, const unsigned char channel)

Get the current State for the Port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • state – The port mode setting. Mode will be filled with the current setting. Mode bits that are not used will be marked as don’t care

Returns:

Returns common entity return values

void usb_getPortError(unsigned int *id, struct Result *result, const unsigned char channel)

Get the current error for the Port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • error – The port mode setting. Mode will be filled with the current setting. Mode bits that are not used will be marked as don’t care

Returns:

Returns common entity return values

void usb_setUpstreamBoostMode(unsigned int *id, struct Result *result, const unsigned char setting)

Set the upstream boost mode. Boost mode increases the drive strength of the USB data signals (power signals are not changed). Boosting the data signal strength may help to overcome connectivity issues when using long cables or connecting through “pogo” pins. Possible modes are 0 - no boost, 1 - 4% boost, 2 - 8% boost, 3 - 12% boost. This setting is not applied until a stem.system.save() call and power cycle of the hub. Setting is then persistent until changed or the hub is reset. After reset, default value of 0% boost is restored.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • setting – Upstream boost setting 0, 1, 2, or 3.

Returns:

Returns common entity return values

void usb_setDownstreamBoostMode(unsigned int *id, struct Result *result, const unsigned char setting)

Set the downstream boost mode. Boost mode increases the drive strength of the USB data signals (power signals are not changed). Boosting the data signal strength may help to overcome connectivity issues when using long cables or connecting through “pogo” pins. Possible modes are 0 - no boost, 1 - 4% boost, 2 - 8% boost, 3 - 12% boost. This setting is not applied until a stem.system.save() call and power cycle of the hub. Setting is then persistent until changed or the hub is reset. After reset, default value of 0% boost is restored.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • setting – Downstream boost setting 0, 1, 2, or 3.

Returns:

Returns common entity return values

void usb_getUpstreamBoostMode(unsigned int *id, struct Result *result)

Get the upstream boost mode. Possible modes are 0 - no boost, 1 - 4% boost, 2 - 8% boost, 3 - 12% boost.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void usb_getDownstreamBoostMode(unsigned int *id, struct Result *result)

Get the downstream boost mode. Possible modes are 0 - no boost, 1 - 4% boost, 2 - 8% boost, 3 - 12% boost.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void usb_getDownstreamDataSpeed(unsigned int *id, struct Result *result, const unsigned char channel)

Get the current data transfer speed for the downstream port. The data speed can be Hi-Speed (2.0) or SuperSpeed (3.0) depending on what the downstream device attached is using

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • speed – Filled with the current port data speed

    • N/A: usbDownstreamDataSpeed_na = 0

    • Hi Speed: usbDownstreamDataSpeed_hs = 1

    • SuperSpeed: usbDownstreamDataSpeed_ss = 2

Returns:

Returns common entity return values

void usb_setConnectMode(unsigned int *id, struct Result *result, const unsigned char channel, const unsigned char mode)

Sets the connect mode of the switch.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • channel – The USB sub channel.

  • mode – The connect mode

    • usbManualConnect = 0

    • usbAutoConnect = 1

Returns:

Returns common entity return values

void usb_getConnectMode(unsigned int *id, struct Result *result, const unsigned char channel)

Gets the connect mode of the switch.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • mode – The current connect mode

Returns:

Returns common entity return values

void usb_setCC1Enable(unsigned int *id, struct Result *result, const unsigned char channel, const unsigned char bEnable)

Set Enable/Disable on the CC1 line.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • channel – - USB channel.

  • bEnable –

    • Disabled: 0

    • Enabled: 1

Returns:

Returns common entity return values

void usb_getCC1Enable(unsigned int *id, struct Result *result, const unsigned char channel)

Get Enable/Disable on the CC1 line.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • pEnable –

    • Disabled: 0

    • Enabled: 1

Returns:

Returns common entity return values

void usb_setCC2Enable(unsigned int *id, struct Result *result, const unsigned char channel, const unsigned char bEnable)

Set Enable/Disable on the CC2 line.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • channel – - USB channel.

  • bEnable –

    • Disabled: 0

    • Enabled: 1

Returns:

Returns common entity return values

void usb_getCC2Enable(unsigned int *id, struct Result *result, const unsigned char channel)

Get Enable/Disable on the CC1 line.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • pEnable –

    • Disabled: 0

    • Enabled: 1

Returns:

Returns common entity return values

void usb_getCC1Current(unsigned int *id, struct Result *result, const unsigned char channel)

Get the current through the CC1 for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • microamps – The USB channel current in micro-amps (1 == 1e-6A).

Returns:

Returns common entity return values

void usb_getCC2Current(unsigned int *id, struct Result *result, const unsigned char channel)

Get the current through the CC2 for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • microamps – The USB channel current in micro-amps (1 == 1e-6A).

Returns:

Returns common entity return values

void usb_getCC1Voltage(unsigned int *id, struct Result *result, const unsigned char channel)

Get the voltage of CC1 for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • microvolts – The USB channel voltage in micro-volts (1 == 1e-6V).

Returns:

Returns common entity return values

void usb_getCC2Voltage(unsigned int *id, struct Result *result, const unsigned char channel)

Get the voltage of CC2 for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • microvolts – The USB channel voltage in micro-volts (1 == 1e-6V).

Returns:

Returns common entity return values

void usb_setSBUEnable(unsigned int *id, struct Result *result, const unsigned char channel, const unsigned char bEnable)

Enable/Disable only the SBU1/2 based on the configuration of the usbPortMode settings.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • channel – The USB sub channel.

  • bEnable –

    • Disabled: 0

    • Enabled: 1

Returns:

Returns common entity return values

void usb_getSBUEnable(unsigned int *id, struct Result *result, const unsigned char channel)

Get the Enable/Disable status of the SBU

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • pEnable – The enable/disable status of the SBU

Returns:

Returns common entity return values

void usb_setCableFlip(unsigned int *id, struct Result *result, const unsigned char channel, const unsigned char bEnable)

Set Cable flip. This will flip SBU, CC and SS data lines.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • channel – The USB sub channel.

  • bEnable –

    • Disabled: 0

    • Enabled: 1

Returns:

Returns common entity return values

void usb_getCableFlip(unsigned int *id, struct Result *result, const unsigned char channel)

Get Cable flip setting.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • pEnable – The enable/disable status of cable flip.

Returns:

Returns common entity return values

void usb_setAltModeConfig(unsigned int *id, struct Result *result, const unsigned char channel, const unsigned int configuration)

Set USB Alt Mode Configuration.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • channel – The USB sub channel

  • configuration – The USB configuration to be set for the given channel.

Returns:

Returns common entity return values

void usb_getAltModeConfig(unsigned int *id, struct Result *result, const unsigned char channel)

Get USB Alt Mode Configuration.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • configuration – The USB configuration for the given channel.

Returns:

Returns common entity return values

void usb_getSBU1Voltage(unsigned int *id, struct Result *result, const unsigned char channel)

Get the voltage of SBU1 for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • microvolts – The USB channel voltage in micro-volts (1 == 1e-6V).

Returns:

Returns common entity return values

void usb_getSBU2Voltage(unsigned int *id, struct Result *result, const unsigned char channel)

Get the voltage of SBU2 for a port.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • microvolts – The USB channel voltage in micro-volts (1 == 1e-6V).

Returns:

Returns common entity return values