USBSystem Entity

group USBSystemEntity

USBSystem Class The USBSystem class provides high level control of the lower level Port Class.

void usbsystem_getUpstream(unsigned int *id, struct Result *result, const int index)

Gets the upstream 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.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void usbsystem_setUpstream(unsigned int *id, struct Result *result, const int index, const unsigned char port)

Sets the upstream port.

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

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

  • index – The index of the entity in question.

  • port – The upstream port to set.

Returns:

Returns common entity return values

void usbsystem_getEnumerationDelay(unsigned int *id, struct Result *result, const int index)

Gets the inter-port enumeration delay in milliseconds. Delay is applied upon hub enumeration.

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.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void usbsystem_setEnumerationDelay(unsigned int *id, struct Result *result, const int index, const unsigned int msDelay)

Sets the inter-port enumeration delay in milliseconds. Delay is applied upon hub enumeration.

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

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

  • index – The index of the entity in question.

  • msDelay – The delay in milliseconds to be applied between port enables

Returns:

Returns common entity return values

void usbsystem_getDataRoleList(unsigned int *id, struct Result *result, const int index)

Gets the data role of all ports with a single call Equivalent to calling PortClass::getDataRole() on each individual 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.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void usbsystem_getEnabledList(unsigned int *id, struct Result *result, const int index)

Gets the current enabled status of all ports with a single call. Equivalent to calling PortClass::setEnabled() on each 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.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void usbsystem_setEnabledList(unsigned int *id, struct Result *result, const int index, const unsigned int enabledList)

Sets the enabled status of all ports with a single call. Equivalent to calling PortClass::setEnabled() on each port.

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

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

  • index – The index of the entity in question.

  • enabledList – Bit packed representation of the enabled status for all ports to be applied.

Returns:

Returns common entity return values

void usbsystem_getModeList(unsigned int *id, struct Result *result, const int index, unsigned int *buffer, const int bufferLength)

Gets the current mode of all ports with a single call. Equivalent to calling PortClass:getMode() on each port.

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

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

  • index – The index of the entity in question.

  • buffer – pointer to the start of a c style buffer to be filled

  • bufLength – Length of the buffer to be filed

  • unloadedLength – Length that was actually received and filled.

Returns:

Returns common entity return values

void usbsystem_setModeList(unsigned int *id, struct Result *result, const int index, const unsigned int bufLength)

Sets the mode of all ports with a single call. Equivalent to calling PortClass::setMode() on each 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.

  • index – The index of the entity in question.

  • bufLength – Length of the buffer to be transferred.

Returns:

Returns common entity return values

void usbsystem_getStateList(unsigned int *id, struct Result *result, const int index, unsigned int *buffer, const int bufferLength)

Gets the state for all ports with a single call. Equivalent to calling PortClass::getState() on each port.

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

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

  • index – The index of the entity in question.

  • buffer – pointer to the start of a c style buffer to be filled

  • bufLength – Length of the buffer to be filed

  • unloadedLength – Length that was actually received and filled.

Returns:

Returns common entity return values

void usbsystem_getPowerBehavior(unsigned int *id, struct Result *result, const int index)

Gets the behavior of the power manager. The power manager is responsible for budgeting the power of the system. i.e. What happens when requested power greater than available power.

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.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void usbsystem_setPowerBehavior(unsigned int *id, struct Result *result, const int index, const unsigned char behavior)

Sets the behavior of how available power is managed. i.e. What happens when requested power is greater than available power.

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

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

  • index – The index of the entity in question.

  • behavior – An enumerated representation of behavior. Available behaviors are product specific. See the reference documentation.

Returns:

Returns common entity return values

void usbsystem_getPowerBehaviorConfig(unsigned int *id, struct Result *result, const int index, unsigned int *buffer, const int bufferLength)

Gets the current power behavior configuration Certain power behaviors use a list of ports to determine priority when budgeting power.

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

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

  • index – The index of the entity in question.

  • buffer – pointer to the start of a c style buffer to be filled

  • bufLength – Length of the buffer to be filed

  • unloadedLength – Length that was actually received and filled.

Returns:

Returns common entity return values

void usbsystem_setPowerBehaviorConfig(unsigned int *id, struct Result *result, const int index, const unsigned int bufLength)

Sets the current power behavior configuration Certain power behaviors use a list of ports to determine priority when budgeting power.

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.

  • index – The index of the entity in question.

  • bufLength – Length of the buffer to be transferred.

Returns:

Returns common entity return values

void usbsystem_getDataRoleBehavior(unsigned int *id, struct Result *result, const int index)

Gets the behavior of how upstream and downstream ports are determined. i.e. How do you manage requests for data role swaps and new upstream connections.

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.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void usbsystem_setDataRoleBehavior(unsigned int *id, struct Result *result, const int index, const unsigned char behavior)

Sets the behavior of how upstream and downstream ports are determined. i.e. How do you manage requests for data role swaps and new upstream connections.

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

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

  • index – The index of the entity in question.

  • behavior – An enumerated representation of behavior. Available behaviors are product specific. See the reference documentation.

Returns:

Returns common entity return values

void usbsystem_getDataRoleBehaviorConfig(unsigned int *id, struct Result *result, const int index, unsigned int *buffer, const int bufferLength)

Gets the current data role behavior configuration Certain data role behaviors use a list of ports to determine priority host priority.

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

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

  • index – The index of the entity in question.

  • buffer – pointer to the start of a c style buffer to be filled

  • bufLength – Length of the buffer to be filed

  • unloadedLength – Length that was actually received and filled.

Returns:

Returns common entity return values

void usbsystem_setDataRoleBehaviorConfig(unsigned int *id, struct Result *result, const int index, const unsigned int bufLength)

Sets the current data role behavior configuration Certain data role behaviors use a list of ports to determine host priority.

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.

  • index – The index of the entity in question.

  • bufLength – Length of the buffer to be transferred.

Returns:

Returns common entity return values

Warning

doxygenfunction: Cannot find function “usbsystem_getSelectorMode” in doxygen xml output for project “BrainStem2_LabVIEW” from directory: doxml/labVIEW/xml

Warning

doxygenfunction: Cannot find function “usbsystem_setSelectorMode” in doxygen xml output for project “BrainStem2_LabVIEW” from directory: doxml/labVIEW/xml

void usbsystem_resetEntityToFactoryDefaults(unsigned int *id, struct Result *result, const int index)