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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

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

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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.

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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. the current inter-port delay in milliseconds.

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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

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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. A bit packed representation of the data role for all ports.

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Bit packed representation of the enabled status for all ports.

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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.

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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Length that was actually received and filled.

• 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, 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

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Length that was actually received and filled.

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Variable to be filled with an enumerated representation of behavior. Available behaviors are product specific. See the reference documentation.

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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.

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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Length that was actually received and filled.

• 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, 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Variable to be filled with an enumerated representation of behavior. Available behaviors are product specific. See the reference documentation.

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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.

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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Length that was actually received and filled.

• 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, 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Variable to be filled with the selector mode

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

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

• index – The index of the entity in question.

• mode – Mode to be set.

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

Resets the USBSystemClass Entity to it factory default configuration.

Parameters:

• id – ID assigned through “module_createStem”

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

• index – The index of the entity in question.

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

Gets the USB HighSpeed upstream port.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

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

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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.

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

Gets the USB SuperSpeed upstream port.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

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

• 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.

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• 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.

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

Gets the current enabled overrides

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Bit mapped representation of the current override configuration.

• 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

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

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

• 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

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

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

• 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

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Current maximum datarate for the USB HighSpeed signals.

• 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

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

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

• 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

Returns common entity return values

Parameters:

• id – ID assigned through “module_createStem”

• result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Current maximum datarate for the USB SuperSpeed signals.

• index – The index of the entity in question.