class SinkFixedPowerSupplyData

class SinkFixedPowerSupplyData

Defined at line 398 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

Well-regulated power supply that maintains a fixed voltage.

See `PowerData` for a general description of the PDO (Power Data Object)

representation.

Source capabilities for a well-regulated power supply are expressed via

`FixedPowerSupplyData` instances.

usbpd3.1 6.4.1.3.1 "Sink Fixed Supply Power Data Object"

Public Methods

usb_pd::SinkFixedPowerSupplyData & set_supports_dual_role_power (typename std::remove_reference_t<decltype(bits_)> val)

Indicates support for the PR_Swap message.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 407 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

typename std::remove_reference_t<decltype(bits_)> supports_dual_role_power ()

Indicates support for the PR_Swap message.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 407 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

typename std::remove_reference_t<decltype(bits_)> requires_more_than_5v ()

True if the Sink needs more than vSafe5V for full functionality.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 412 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

usb_pd::SinkFixedPowerSupplyData & set_requires_more_than_5v (typename std::remove_reference_t<decltype(bits_)> val)

True if the Sink needs more than vSafe5V for full functionality.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 412 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

typename std::remove_reference_t<decltype(bits_)> has_unconstrained_power ()

True iff the Sink draws power from an "unlimited" power source.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 417 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

usb_pd::SinkFixedPowerSupplyData & set_has_unconstrained_power (typename std::remove_reference_t<decltype(bits_)> val)

True iff the Sink draws power from an "unlimited" power source.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 417 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

usb_pd::SinkFixedPowerSupplyData & set_supports_usb_communications (typename std::remove_reference_t<decltype(bits_)> val)

Indicates if the Sink can communicate over a USB data channel.

The data channels are D+/- introduced in usb2.0 and SS Tx/Rx introduced in

usb3.0.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 425 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

typename std::remove_reference_t<decltype(bits_)> supports_usb_communications ()

Indicates if the Sink can communicate over a USB data channel.

The data channels are D+/- introduced in usb2.0 and SS Tx/Rx introduced in

usb3.0.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 425 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

usb_pd::SinkFixedPowerSupplyData & set_supports_dual_role_data (typename std::remove_reference_t<decltype(bits_)> val)

Indicates support for the DR_Swap message.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 430 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

typename std::remove_reference_t<decltype(bits_)> supports_dual_role_data ()

Indicates support for the DR_Swap message.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 430 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

FastSwapCurrentRequirement fast_swap_current_requirement ()

Current level needed by Sink after a Fast Role Swap.

If the value is `kNotSupported`, the Source will not initiate a Fast Role

Swap request.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 438 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

usb_pd::SinkFixedPowerSupplyData & set_fast_swap_current_requirement (FastSwapCurrentRequirement val)

Current level needed by Sink after a Fast Role Swap.

If the value is `kNotSupported`, the Source will not initiate a Fast Role

Swap request.

Only used on the first PDO in a Sink_Capabilities message.

Defined at line 438 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

usb_pd::SinkFixedPowerSupplyData & set_voltage_50mv (typename std::remove_reference_t<decltype(bits_)> val)

The power source's fixed voltage, in multiplies of 50 mV.

Defined at line 441 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

typename std::remove_reference_t<decltype(bits_)> voltage_50mv ()

The power source's fixed voltage, in multiplies of 50 mV.

Defined at line 441 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

typename std::remove_reference_t<decltype(bits_)> maximum_current_10ma ()

The maximum current offered by the source, in multiples of 10 mA.

Defined at line 444 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

usb_pd::SinkFixedPowerSupplyData & set_maximum_current_10ma (typename std::remove_reference_t<decltype(bits_)> val)

The maximum current offered by the source, in multiples of 10 mA.

Defined at line 444 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

int32_t voltage_mv ()

The power source's fixed voltage, in mV (millivolts).

Defined at line 447 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

SinkFixedPowerSupplyData & set_voltage_mv (int32_t voltage_mv)

Defined at line 452 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

int32_t maximum_current_ma ()

The maximum current offered by the source, in mA (milliamperes).

Defined at line 457 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

SinkFixedPowerSupplyData & set_maximum_current_ma (int32_t current_ma)

Defined at line 462 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

void SinkFixedPowerSupplyData (PowerData power_data)

Debug-checked casting from PowerData.

Defined at line 467 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

void SinkFixedPowerSupplyData ()

Instance with all fields except for type set to zero.

This is an invalid PDO (power data object). At a minimum, voltage and

maximum current must be set before use in a PD message.

Defined at line 475 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

void SinkFixedPowerSupplyData (const SinkFixedPowerSupplyData & )

Value type, copying is allowed.

Defined at line 479 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

SinkFixedPowerSupplyData & operator= (const SinkFixedPowerSupplyData & )

Defined at line 480 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

void ~SinkFixedPowerSupplyData ()

Trivially destructible.

Defined at line 483 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

uint32_t operator unsigned int ()

Support explicit casting to uint32_t.

Defined at line 486 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

bool operator== (const SinkFixedPowerSupplyData & other)

In C++20, equality comparison can be defaulted.

Defined at line 489 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h

bool operator!= (const SinkFixedPowerSupplyData & other)

Defined at line 490 of file ../../src/devices/power/drivers/fusb302/usb-pd-message-objects.h