USBSystem Entity

See the USBSystem Entity for generic information.

group USBSystemEntity

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.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

Sets the upstream port.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • port – The upstream port to set.

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.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

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

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.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

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

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

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

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

  • bufferLength – Length of the buffer to be filed

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

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

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • buffer – Pointer to the start of a c style buffer to be transferred.

  • bufferLength – Length of the buffer to be transferred.

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

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

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

  • bufferLength – Length of the buffer to be filed

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.

The result parameter will output the following fields:

  • error: Common EntityClass Return Values common entity return value

  • value: Variable to be filled with an enumerated representation of behavior. Available behaviors are product specific. See the reference documentation.

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

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

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

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

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

  • bufferLength – Length of the buffer to be filed

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

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

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • buffer – Pointer to the start of a c style buffer to be transferred.

  • bufferLength – Length of the buffer to be transferred.

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.

The result parameter will output the following fields:

  • error: Common EntityClass Return Values common entity return value

  • value: Variable to be filled with an enumerated representation of behavior. Available behaviors are product specific. See the reference documentation.

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

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

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

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

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

  • bufferLength – Length of the buffer to be filed

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

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

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • buffer – Pointer to the start of a c style buffer to be transferred.

  • bufferLength – Length of the buffer to be transferred.

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

Gets the current mode of the selector input. This mode determines what happens and in what order when the external selector input is used.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

Sets the current mode of the selector input. This mode determines what happens and in what order when the external selector input is used.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • mode – Mode to be set.

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

Gets the USB HighSpeed upstream port.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

Sets the USB HighSpeed upstream port.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • port – The upstream port to set.

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

Gets the USB SuperSpeed upstream port.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

Sets the USB SuperSpeed upstream port.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • port – The upstream port to set.

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

Gets the current enabled overrides

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

Sets the current enabled overrides

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • overrides – Overrides to be set in a bit mapped representation.

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

Sets the USB HighSpeed Max datarate

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • datarate – Maximum datarate for the USB HighSpeed signals.

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

Gets the USB HighSpeed Max datarate

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

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

Sets the USB SuperSpeed Max datarate

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • datarate – Maximum datarate for the USB SuperSpeed signals.

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

Gets the USB SuperSpeed Max datarate

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.