Zephyr API Documentation  3.4.0
A Scalable Open Source RTOS
3.4.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
pd_rdo Union Reference

The Request Data Object (RDO) Shall be returned by the Sink making a request for power. See Section 6.4.2 Request Message. More...

#include <usbc_pd.h>

Data Fields

struct {
   uint32_t   min_or_max_operating_current: 10
 
   uint32_t   operating_current: 10
 
   uint32_t   reserved0: 3
 
   uint32_t   unchunked_ext_msg_supported: 1
 
   uint32_t   no_usb_suspend: 1
 
   uint32_t   usb_comm_capable: 1
 
   uint32_t   cap_mismatch: 1
 
   uint32_t   giveback: 1
 
   uint32_t   object_pos: 3
 
   uint32_t   reserved1: 1
 
fixed
 Create a Fixed RDO value See Table 6-19 Fixed and Variable Request Data Object.
 
struct {
   uint32_t   min_or_max_operating_current: 10
 
   uint32_t   operating_current: 10
 
   uint32_t   reserved0: 3
 
   uint32_t   unchunked_ext_msg_supported: 1
 
   uint32_t   no_usb_suspend: 1
 
   uint32_t   usb_comm_capable: 1
 
   uint32_t   cap_mismatch: 1
 
   uint32_t   giveback: 1
 
   uint32_t   object_pos: 3
 
   uint32_t   reserved1: 1
 
variable
 Create a Variable RDO value See Table 6-19 Fixed and Variable Request Data Object.
 
struct {
   uint32_t   min_operating_power: 10
 
   uint32_t   operating_power: 10
 
   uint32_t   reserved0: 3
 
   uint32_t   unchunked_ext_msg_supported: 1
 
   uint32_t   no_usb_suspend: 1
 
   uint32_t   usb_comm_capable: 1
 
   uint32_t   cap_mismatch: 1
 
   uint32_t   giveback: 1
 
   uint32_t   object_pos: 3
 
   uint32_t   reserved1: 1
 
battery
 Create a Battery RDO value See Table 6-20 Battery Request Data Object.
 
struct {
   uint32_t   operating_current: 7
 
   uint32_t   reserved0: 2
 
   uint32_t   output_voltage: 11
 
   uint32_t   reserved1: 3
 
   uint32_t   unchunked_ext_msg_supported: 1
 
   uint32_t   no_usb_suspend: 1
 
   uint32_t   usb_comm_capable: 1
 
   uint32_t   cap_mismatch: 1
 
   uint32_t   reserved2: 1
 
   uint32_t   object_pos: 3
 
   uint32_t   reserved3: 1
 
augmented
 Create an Augmented RDO value See Table 6-22 Programmable Request Data Object.
 
uint32_t raw_value
 

Detailed Description

The Request Data Object (RDO) Shall be returned by the Sink making a request for power. See Section 6.4.2 Request Message.

Field Documentation

◆ 

struct { ... } pd_rdo::augmented

Create an Augmented RDO value See Table 6-22 Programmable Request Data Object.

◆ 

struct { ... } pd_rdo::battery

Create a Battery RDO value See Table 6-20 Battery Request Data Object.

◆ cap_mismatch

uint32_t pd_rdo::cap_mismatch

Capability Mismatch

◆ 

struct { ... } pd_rdo::fixed

Create a Fixed RDO value See Table 6-19 Fixed and Variable Request Data Object.

◆ giveback

uint32_t pd_rdo::giveback

Give Back Flag

◆ min_operating_power

uint32_t pd_rdo::min_operating_power

Minimum Operating Power in 250mW units

◆ min_or_max_operating_current

uint32_t pd_rdo::min_or_max_operating_current

Operating Current 10mA units NOTE: If Give Back Flag is zero, this field is the Maximum Operating Current. If Give Back Flag is one, this field is the Minimum Operating Current.

◆ no_usb_suspend

uint32_t pd_rdo::no_usb_suspend

No USB Suspend

◆ object_pos

uint32_t pd_rdo::object_pos

Object Position (000b is Reserved and Shall Not be used)

◆ operating_current

uint32_t pd_rdo::operating_current

Operating current in 10mA units

Operating Current 50mA units

◆ operating_power

uint32_t pd_rdo::operating_power

Operating power in 250mW units

◆ output_voltage

uint32_t pd_rdo::output_voltage

Output Voltage in 20mV units

◆ raw_value

uint32_t pd_rdo::raw_value

Raw RDO value

◆ reserved0

uint32_t pd_rdo::reserved0

Reserved - Shall be set to zero.

◆ reserved1

uint32_t pd_rdo::reserved1

Reserved - Shall be set to zero.

◆ reserved2

uint32_t pd_rdo::reserved2

Reserved - Shall be set to zero

◆ reserved3

uint32_t pd_rdo::reserved3

Reserved - Shall be set to zero.

◆ unchunked_ext_msg_supported

uint32_t pd_rdo::unchunked_ext_msg_supported

Unchunked Extended Messages Supported

◆ usb_comm_capable

uint32_t pd_rdo::usb_comm_capable

USB Communications Capable

◆ 

struct { ... } pd_rdo::variable

Create a Variable RDO value See Table 6-19 Fixed and Variable Request Data Object.


The documentation for this union was generated from the following file: