PDStack Middleware Library 1.20
cy_stc_pdstack_port_cfg_t Struct Reference

Description

Structure to hold PDSTACK Middleware configuration information.

Data Fields

uint32_t signature
 Structure Signature - 'PDSC'.
 
uint16_t version
 Configuration parameter version. More...
 
uint8_t mfgLenInfo
 Length of Manufacturer Information. More...
 
uint8_t reserved0
 Reserved byte for alignment. More...
 
uint16_t mfgVid
 Manufacturer Vendor Id. More...
 
uint16_t mfgPid
 Manufacturer Product Id. More...
 
uint8_t mfgName [22]
 Manufacturer Name. More...
 
uint8_t scedbEn
 Extended Source Capability message support 1 - Enable support 0 - Disable support.
 
uint8_t skedbEn
 Extended Sink Capability message support 1 - Enable support 0 - Disable support.
 
uint8_t extSrcCap [25]
 Extended Source Capability response.
 
uint8_t extSnkCap [25]
 Extended Sink Capability response.
 
uint8_t portRole
 PD port role: 0 - Sink 1 - Source 2 - Dual Role.
 
uint8_t defPortRole
 Default port role in case of dual role ports: 0 - Sink 1 - Source.
 
uint8_t curLevel
 Type-C current level (Rp value) used as source: 0 - 900 mA 1 - 1.5 A 2 - 3 A.
 
uint8_t cableDiscCount
 Number of cable discovery attempts to be made Range: 0x00 - 0x14.
 
uint8_t srcPdoFlags [2]
 B29:B20 of the first 5V Fixed Source PDO.
 
uint8_t snkPdoFlags [2]
 B29:B20 of the first 5V Fixed Sink PDO.
 
uint8_t drpToggleEn
 Whether Rp-Rd toggle is enabled in unattached state. More...
 
uint8_t rpSupported
 Bitmask that specifies supported Rp values: Bit 0 - 900 mA Rp Bit 1 - 1.5 A Rp Bit 2 - 3 A Rp.
 
uint8_t pdOpEn
 Whether USB-PD operation is supported on the port. More...
 
uint8_t prefPwrRole
 Whether Try.Src or Try.Sink is enabled for the port: 0 - No Try.Src or Try.Sink supported 1 - Try.Src supported 2 - Try.Sink supported.
 
uint8_t portDis
 Whether the PD port is to be disabled at start-up. More...
 
uint8_t cableDiscEn
 Whether cable discovery is enabled as part of the source state machine. More...
 
uint8_t deadBatSupp
 Whether dead battery operation is supported. More...
 
uint8_t errorRecoveryEn
 Whether Type C Error Recovery is enabled. More...
 
uint8_t accessoryEn
 Whether to enable/disable accessory mode 1 - Enable accessory mode 0 - Disable accessory mode.
 
uint8_t rpDetachEn
 Whether to enable/disable disconnect detect mechanism using Rp in Sink role 1 - Enable disconnect detect using Rp in Sink Role 0 - Disable disconnect detect using Rp in Sink Role.
 
uint8_t vconnRetain
 Whether Vconn supply should be left enabled even if the EMCA's cable VDO indicates that Vconn is not required. More...
 
uint8_t frsConfig
 Fast Role Swap feature enabled flags: Bit 0 - FRS receive enable Bit 1 - FRS transmit enable.
 
uint8_t srcPdoCount
 Number of source PDOs supported (max. More...
 
uint8_t defSrcPdoMask
 Bitmask that enables specified entries in the Src. More...
 
uint8_t snkPdoCount
 Number of sink PDOs supported (max. More...
 
uint8_t defSnkPdoMask
 Bitmask that enables specified entries in the Sink PDO list. More...
 
uint32_t srcPdo [7]
 Source PDO list.
 
uint32_t snkPdo [7]
 Sink PDO list.
 
uint16_t snkPdoMinMaxCur [7]
 Sink PDO Min/Max Current list.
 
uint16_t reserved2
 Reserved for future use. More...
 
uint32_t pdRevision
 Get_Revision message response.
 
uint32_t srcInfo
 Get_Source_Info message response.
 
uint8_t eprSrcPdoCount
 Number of EPR source PDOs supported. More...
 
uint8_t eprSrcPdoMask
 Bit-mask enabling each EPR source PDO. More...
 
uint8_t eprSnkPdoCount
 Number of EPR sink PDOs supported. More...
 
uint8_t eprSnkPdoMask
 Bit-mask enabling each EPR sink PDO. More...
 
uint32_t eprSrcPdo [6]
 EPR Source PDO List.
 
uint32_t eprSnkPdo [6]
 EPR Sink PDO List.
 

Field Documentation

◆ version

uint16_t cy_stc_pdstack_port_cfg_t::version

Configuration parameter version.

Consists of 8-bit major(bits 15:8) and 8-bit minor(bits 7:0) version

◆ mfgLenInfo

uint8_t cy_stc_pdstack_port_cfg_t::mfgLenInfo

Length of Manufacturer Information.

0 - For no information. 5 to 26: For valid information.

◆ reserved0

uint8_t cy_stc_pdstack_port_cfg_t::reserved0

Reserved byte for alignment.

◆ mfgVid

uint16_t cy_stc_pdstack_port_cfg_t::mfgVid

Manufacturer Vendor Id.

Range 0x0000 - 0xFFFF.

◆ mfgPid

uint16_t cy_stc_pdstack_port_cfg_t::mfgPid

Manufacturer Product Id.

Range 0x0000 - 0xFFFF.

◆ mfgName

uint8_t cy_stc_pdstack_port_cfg_t::mfgName[22]

Manufacturer Name.

Null terminated string.

◆ drpToggleEn

uint8_t cy_stc_pdstack_port_cfg_t::drpToggleEn

Whether Rp-Rd toggle is enabled in unattached state.

◆ pdOpEn

uint8_t cy_stc_pdstack_port_cfg_t::pdOpEn

Whether USB-PD operation is supported on the port.

1 - Enable PD Operation 0 - Disable PD Operation

◆ portDis

uint8_t cy_stc_pdstack_port_cfg_t::portDis

Whether the PD port is to be disabled at start-up.

◆ cableDiscEn

uint8_t cy_stc_pdstack_port_cfg_t::cableDiscEn

Whether cable discovery is enabled as part of the source state machine.

1 - Enable Cable Discovery 0 - Disable Cable Discovery

◆ deadBatSupp

uint8_t cy_stc_pdstack_port_cfg_t::deadBatSupp

Whether dead battery operation is supported.

1 - Dead battery operation is supported. 0 - Dead battery operation is not supported.

◆ errorRecoveryEn

uint8_t cy_stc_pdstack_port_cfg_t::errorRecoveryEn

Whether Type C Error Recovery is enabled.

1 - Enable error recovery 0 - Disable error recovery

◆ vconnRetain

uint8_t cy_stc_pdstack_port_cfg_t::vconnRetain

Whether Vconn supply should be left enabled even if the EMCA's cable VDO indicates that Vconn is not required.

◆ srcPdoCount

uint8_t cy_stc_pdstack_port_cfg_t::srcPdoCount

Number of source PDOs supported (max.

value is 7)

◆ defSrcPdoMask

uint8_t cy_stc_pdstack_port_cfg_t::defSrcPdoMask

Bitmask that enables specified entries in the Src.

PDO list.

◆ snkPdoCount

uint8_t cy_stc_pdstack_port_cfg_t::snkPdoCount

Number of sink PDOs supported (max.

value is 7)

◆ defSnkPdoMask

uint8_t cy_stc_pdstack_port_cfg_t::defSnkPdoMask

Bitmask that enables specified entries in the Sink PDO list.

◆ reserved2

uint16_t cy_stc_pdstack_port_cfg_t::reserved2

Reserved for future use.

◆ eprSrcPdoCount

uint8_t cy_stc_pdstack_port_cfg_t::eprSrcPdoCount

Number of EPR source PDOs supported.

Non-zero value enables EPR source operation. Range: 0 - 6

◆ eprSrcPdoMask

uint8_t cy_stc_pdstack_port_cfg_t::eprSrcPdoMask

Bit-mask enabling each EPR source PDO.

◆ eprSnkPdoCount

uint8_t cy_stc_pdstack_port_cfg_t::eprSnkPdoCount

Number of EPR sink PDOs supported.

Non-zero value enables EPR sink operation. Range: 0 - 6

◆ eprSnkPdoMask

uint8_t cy_stc_pdstack_port_cfg_t::eprSnkPdoMask

Bit-mask enabling each EPR sink PDO.