Power Delivery Class¶
- class PowerDeliveryClass : public EntityClass¶
Power Delivery Class. Power Delivery or PD is a power specification which allows more charging options and device behaviors within the USB interface. This Entity will allow you to directly access the vast landscape of PD.
Public Functions
- PowerDeliveryClass()¶
Constructors.
- ~PowerDeliveryClass(void)¶
Destructor.
- !PowerDeliveryClass ()
Finalizer.
- void init (BrainStem2CLI::ModuleClass^ module, const unsigned char index)
Initializes the class. Should only be called when manually creating classes.
- Parameters:
pModule – The module.
index – The cmdPOWERDELIVERY index to be addressed.
- aErr getConnectionState(unsigned char %state)¶
Gets the current state of the connection in the form of an enumeration.
- Parameters:
state – Pointer to be filled with the current connection state.
- Returns:
Returns common entity return values
- aErr getNumberOfPowerDataObjects(const unsigned char partner, const unsigned char powerRole, unsigned char %numRules)¶
Gets the number of Power Data Objects (PDOs) for a given partner and power role.
- Parameters:
partner – Indicates which side of the PD connection is in question.
Local = 0 = powerdeliveryPartnerLocal
Remote = 1 = powerdeliveryPartnerRemote
powerRole – Indicates which power role of PD connection is in question.
Source = 1 = powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
numRules – Variable to be filled with the number of PDOs.
- Returns:
Returns common entity return values
- aErr getPowerDataObject(const unsigned char partner, const unsigned char powerRole, const unsigned char ruleIndex, unsigned int %pdo)¶
Gets the Power Data Object (PDO) for the requested partner, powerRole and index.
- Parameters:
partner – Indicates which side of the PD connection is in question.
Local = 0 = powerdeliveryPartnerLocal
Remote = 1 = powerdeliveryPartnerRemote
powerRole – Indicates which power role of PD connection is in question.
Source = 1 = powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
ruleIndex – The index of the PDO in question. Valid index are 1-7.
pdo – Variable to be filled with the requested power rule.
- Returns:
Returns common entity return values
- aErr setPowerDataObject(const unsigned char powerRole, const unsigned char ruleIndex, const unsigned int pdo)¶
Sets the Power Data Object (PDO) of the local partner for a given power role and index.
- Parameters:
powerRole – Indicates which power role of PD connection is in question.
Source = 1 = powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
ruleIndex – The index of the PDO in question. Valid index are 1-7.
pdo – Power Data Object to be set.
- Returns:
Returns common entity return values
- aErr resetPowerDataObjectToDefault(const unsigned char powerRole, const unsigned char ruleIndex)¶
Resets the Power Data Object (PDO) of the Local partner for a given power role and index.
- Parameters:
powerRole – Indicates which power role of PD connection is in question.
Source = 1 = powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
ruleIndex – The index of the PDO in question. Valid index are 1-7.
- Returns:
Returns common entity return values
- aErr getPowerDataObjectList(unsigned int %buffer, const unsigned int bufLength, unsigned int %unloadedLength)¶
Gets all Power Data Objects (PDOs). Equivalent to calling PowerDeliveryClass::getPowerDataObject() on all partners, power roles, and index’s.
- Parameters:
buffer – pointer to the start of a c style buffer to be filled The order of which is:
Rules 1-7 Local Source
Rules 1-7 Local Sink
Rules 1-7 Partner Source
Rules 1-7 Partner Sink.
bufLength – Length of the buffer to be filed
unloadedLength – Length that was actually received and filled. On success this value should be 28 (7 rules % 2 partners % 2 power roles)
- Returns:
Returns common entity return values
- aErr getPowerDataObjectEnabled(const unsigned char powerRole, const unsigned char ruleIndex, unsigned char %enabled)¶
Gets the enabled state of the Local Power Data Object (PDO) for a given power role and index. Enabled refers to whether the PDO will be advertised when a PD connection is made. This does not indicate the currently active rule index. This information can be found in Request Data Object (RDO).
- Parameters:
powerRole – Indicates which power role of PD connection is in question.
Source = 1 = powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
ruleIndex – The index of the PDO in question. Valid index are 1-7.
enabled – Variable to be filled with enabled state.
- Returns:
Returns common entity return values
- aErr setPowerDataObjectEnabled(const unsigned char powerRole, const unsigned char ruleIndex, const unsigned char enabled)¶
Sets the enabled state of the Local Power Data Object (PDO) for a given powerRole and index. Enabled refers to whether the PDO will be advertised when a PD connection is made. This does not indicate the currently active rule index. This information can be found in Request Data Object (RDO).
- Parameters:
powerRole – Indicates which power role of PD connection is in question.
Source = 1 = powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
ruleIndex – The index of the PDO in question. Valid index are 1-7.
enabled – The state to be set.
- Returns:
Returns common entity return values
- aErr getPowerDataObjectEnabledList(const unsigned char powerRole, unsigned char %enabledList)¶
Gets all Power Data Object enables for a given power role. Equivalent of calling PowerDeliveryClass::getPowerDataObjectEnabled() for all indexes.
- Parameters:
powerRole – Indicates which power role of PD connection is in question.
Source = 1 = powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
enabledList – Variable to be filled with a mapped representation of the enabled PDOs for a given power role. Values align with a given rule index (bits 1-7, bit 0 is invalid)
- Returns:
Returns common entity return values
- aErr getRequestDataObject(const unsigned char partner, unsigned int %rdo)¶
Gets the current Request Data Object (RDO) for a given partner. RDOs: Are provided by the sinking device. Exist only after a successful PD negotiation (Otherwise zero). Only one RDO can exist at a time. i.e. Either the Local or Remote partner RDO
- Parameters:
partner – Indicates which side of the PD connection is in question.
Local = 0 = powerdeliveryPartnerLocal
Remote = 1 = powerdeliveryPartnerRemote
rdo – Variable to be filled with the current RDO. Zero indicates the RDO is not active.
- Returns:
Returns common entity return values
- aErr setRequestDataObject(const unsigned int rdo)¶
Sets the current Request Data Object (RDO) for a given partner. (Only the local partner can be changed.) RDOs: Are provided by the sinking device. Exist only after a successful PD negotiation (Otherwise zero). Only one RDO can exist at a time. i.e. Either the Local or Remote partner RDO
- Parameters:
partner – Indicates which side of the PD connection is in question.
Local = 0 = powerdeliveryPartnerLocal
rdo – Request Data Object to be set.
- Returns:
Returns common entity return values
- aErr getPowerRole(unsigned char %powerRole)¶
Gets the power role that is currently being advertised by the local partner. (CC Strapping).
- Parameters:
powerRole – Variable to be filed with the power role
Disabled = 0 = powerdeliveryPowerRoleDisabled
Source = 1= powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
Source/Sink = 3 = powerdeliveryPowerRoleSourceSink (Dual Role Port)
- Returns:
Returns common entity return values
- aErr setPowerRole(const unsigned char powerRole)¶
Set the current power role to be advertised by the Local partner. (CC Strapping).
- Parameters:
powerRole – Value to be applied.
Disabled = 0 = powerdeliveryPowerRoleDisabled
Source = 1= powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
Source/Sink = 3 = powerdeliveryPowerRoleSourceSink (Dual Role Port)
- Returns:
Returns common entity return values
- aErr getPowerRolePreferred(unsigned char %powerRole)¶
Gets the preferred power role currently being advertised by the Local partner. (CC Strapping).
- Parameters:
powerRole – Value to be applied.
Disabled = 0 = powerdeliveryPowerRoleDisabled
Source = 1= powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
- Returns:
Returns common entity return values
- aErr setPowerRolePreferred(const unsigned char powerRole)¶
Set the preferred power role to be advertised by the Local partner (CC Strapping).
- Parameters:
powerRole – Value to be applied.
Disabled = 0 = powerdeliveryPowerRoleDisabled
Source = 1= powerdeliveryPowerRoleSource
Sink = 2 = powerdeliveryPowerRoleSink
- Returns:
Returns common entity return values
- aErr getCableVoltageMax(unsigned char %maxVoltage)¶
Gets the maximum voltage capability reported by the e-mark of the attached cable.
- Parameters:
maxVoltage – Variable to be filled with an enumerated representation of voltage.
Unknown/Unattached (0)
20 Volts DC (1)
30 Volts DC (2)
40 Volts DC (3)
50 Volts DC (4)
- Returns:
Returns common entity return values
- aErr getCableCurrentMax(unsigned char %maxCurrent)¶
Gets the maximum current capability report by the e-mark of the attached cable.
- Parameters:
maxCurrent – Variable to be filled with an enumerated representation of current.
Unknown/Unattached (0)
3 Amps (1)
5 Amps (2)
- Returns:
Returns common entity return values
- aErr getCableSpeedMax(unsigned char %maxSpeed)¶
Gets the maximum data rate capability reported by the e-mark of the attached cable.
- Parameters:
maxSpeed – Variable to be filled with an enumerated representation of data speed.
Unknown/Unattached (0)
USB 2.0 (1)
USB 3.2 gen 1 (2)
USB 3.2 / USB 4 gen 2 (3)
USB 4 gen 3 (4)
- Returns:
Returns common entity return values
- aErr getCableType(unsigned char %type)¶
Gets the cable type reported by the e-mark of the attached cable.
- Parameters:
type – Variable to be filled with an enumerated representation of the cable type.
Invalid, no e-mark and not Vconn powered (0)
Passive cable with e-mark (1)
Active cable (2)
- Returns:
Returns common entity return values
- aErr getCableOrientation(unsigned char %orientation)¶
Gets the current orientation being used for PD communication
- Parameters:
orientation – Variable filled with an enumeration of the orientation.
Unconnected (0)
CC1 (1)
CC2 (2)
- Returns:
Returns common entity return values
- aErr request(const unsigned char request)¶
Requests an action of the Remote partner. Actions are not guaranteed to occur.
- Parameters:
request – Request to be issued to the remote partner
pdRequestHardReset (0)
pdRequestSoftReset (1)
pdRequestDataReset (2)
pdRequestPowerRoleSwap (3)
pdRequestPowerFastRoleSwap (4)
pdRequestDataRoleSwap (5)
pdRequestVconnSwap (6)
pdRequestSinkGoToMinimum (7)
pdRequestRemoteSourcePowerDataObjects (8)
pdRequestRemoteSinkPowerDataObjects (9)
- Returns:
The returned error represents the success of the request being sent to the partner only. The success of the request being serviced by the remote partner can be obtained through PowerDeliveryClass::requestStatus() Returns common entity return values
- aErr requestStatus(unsigned int %status)¶
Gets the status of the last request command sent.
- Parameters:
status – Variable to be filled with the status
- Returns:
Returns common entity return values
- aErr getOverride(unsigned int %overrides)¶
Gets the current enabled overrides
- Parameters:
overrides – Bit mapped representation of the current override configuration.
- Returns:
Returns common entity return values
- aErr setOverride(const unsigned int overrides)¶
Sets the current enabled overrides
- Parameters:
overrides – Overrides to be set in a bit mapped representation.
- Returns:
Returns common entity return values
- aErr resetEntityToFactoryDefaults(void)¶
Resets the PowerDeliveryClass Entity to it factory default configuration.
- aErr getFlagMode(const unsigned char flag, unsigned char %mode)¶
Gets the current mode of the local partner flag/advertisement. These flags are apart of the first Local Power Data Object and must be managed in order to accurately represent the system to other PD devices. This API allows overriding of that feature. Overriding may lead to unexpected behaviors.
- Parameters:
flag – Flag/Advertisement to be modified
mode – Variable to be filled with the current mode.
Disabled (0)
Enabled (1)
Auto (2) default
- Returns:
Returns common entity return values
- aErr setFlagMode(const unsigned char flag, const unsigned char mode)¶
Sets how the local partner flag/advertisement is managed. These flags are apart of the first Local Power Data Object and must be managed in order to accurately represent the system to other PD devices. This API allows overriding of that feature. Overriding may lead to unexpected behaviors.
- Parameters:
flag – Flag/Advertisement to be modified
mode – Value to be applied.
Disabled (0)
Enabled (1)
Auto (2) default
- Returns:
Returns common entity return values
- aErr getPeakCurrentConfiguration(unsigned char %configuration)¶
Gets the Peak Current Configuration for the Local Source. The peak current configuration refers to the allowable tolerance/overload capabilities in regards to the devices max current. This tolerance includes a maximum value and a time unit.
- Parameters:
configuration – An enumerated value referring to the current configuration.
Allowable values are 0 - 4
- Returns:
Returns common entity return values
- aErr setPeakCurrentConfiguration(const unsigned char configuration)¶
Sets the Peak Current Configuration for the Local Source. The peak current configuration refers to the allowable tolerance/overload capabilities in regards to the devices max current. This tolerance includes a maximum value and a time unit.
- Parameters:
configuration – An enumerated value referring to the configuration to be set
Allowable values are 0 - 4
- Returns:
Returns common entity return values
- aErr getFastRoleSwapCurrent(unsigned char %swapCurrent)¶
Gets the Fast Role Swap Current The fast role swap current refers to the amount of current required by the Local Sink in order to successfully preform the swap.
- Parameters:
swapCurrent – An enumerated value referring to current swap value.
0A (0)
900mA (1)
1.5A (2)
3A (3)
- Returns:
Returns common entity return values
- aErr setFastRoleSwapCurrent(const unsigned char swapCurrent)¶
Sets the Fast Role Swap Current The fast role swap current refers to the amount of current required by the Local Sink in order to successfully preform the swap.
- Parameters:
swapCurrent – An enumerated value referring to value to be set.
0A (0)
900mA (1)
1.5A (2)
3A (3)
- Returns:
Returns common entity return values