Data Sheet

ManualsBrandsTELEDYNE LECROY ManualsLaboratory Test EquipmentProtocol analyser Mercury T2C Power Delivery USB

Table Of Contents

Protocol Solutions Group

3385 Scott Blvd., Santa Clara, CA 95054

Tel: +1/408.727.6600

Fax: +1/408.727.6622

USB Power Delivery Exerciser

Manual

Manual Version 1.46

For USB Protocol Suite Software Version 7.45 and above

February 2017

Summary of content (122 pages)

PAGE 1
Protocol Solutions Group 3385 Scott Blvd., Santa Clara, CA 95054 Tel: +1/408.727.6600 Fax: +1/408.727.6622 USB Power Delivery Exerciser Manual Manual Version 1.46 For USB Protocol Suite Software Version 7.
PAGE 2
Document Disclaimer The information contained in this document has been carefully checked and is believed to be reliable. However, no responsibility can be assumed for inaccuracies that may not have been detected. Teledyne LeCroy reserves the right to revise the information presented in this document without notice or penalty. Trademarks and Servicemarks CATC Trace, Voyager M310C, Voyager ReadyLink, USB Protocol Suite, and BusEngine are trademarks of Teledyne LeCroy.
PAGE 3
Contents 1 INTRODUCTION ..................................................................................................................... 12 2 Packet Templates ............................................................................................................. 14 2.1 PD_ControlMessage .................................................................................................. 14 2.2 PD_GoodCrcMessage ...................................................................................
PAGE 4
2.21.2 PD_RequestDataObject_Fixed_Variable_GiveBack........................................... 19 2.21.3 PD_RequestDataObject_Battery_NoGiveBack .................................................. 19 2.21.4 PD_RequestDataObject_Battery_GiveBack....................................................... 19 2.22 PD_BISTCarrierModeMessage............................................................................... 19 2.23 PD_BISTTestDataMessage ..................................................................
PAGE 5
2.37 PD_VDM_Exit_Mode_Response ........................................................................... 26 2.38 PD_VDM_Attention_Message ............................................................................... 26 2.39 PD_VDM_DisplayPort_UpdateStatus_Message ................................................... 26 2.39.1 PD_VDM_DisplayPort_Status_VDO ................................................................... 26 2.40 PD_VDM_DisplayPort_UpdateStatus_Response ............................
PAGE 6
4 3.6 PD_SetVBus ............................................................................................................... 35 3.7 PD_SetVConn ............................................................................................................ 35 3.8 PD_SetLoadOnVBus .................................................................................................. 35 3.9 PD_TerminateCCLines ...............................................................................................
PAGE 7
5 4.22 PD_IncreaseMsgId_Cable ...................................................................................... 55 4.23 PD_DecreaseMsgId_Cable ..................................................................................... 55 Transaction Engine™ ........................................................................................................ 57 5.1 High Level Commands ............................................................................................... 57 5.1.
PAGE 8
5.1.29 PD_GetSinkCapabilities ...................................................................................... 73 5.1.30 PD_WaitForGetSinkCapabilities ......................................................................... 74 5.1.31 PD_SendBISTCarrierMode ................................................................................. 74 5.1.32 PD_SendBISTTestData........................................................................................ 75 5.1.33 PD_GetSourceCapExtended...............
PAGE 9
5.1.61 PD_SetGetManufacturerInfoSetting.................................................................. 89 5.1.62 PD_WaitForGetManufacturerInfo ..................................................................... 89 5.1.63 PD_SetManufacturerInfoDataBlock .................................................................. 90 5.1.64 PD_SetSecurityRequestSetting .......................................................................... 90 5.1.65 PD_SecurityRequest ............................................
PAGE 10
5.1.93 PD_AttentionVdo ............................................................................................. 105 5.1.94 PD_SetDiscoveryProcessSetting ...................................................................... 106 5.1.95 PD_PerformDiscoveryProcess ......................................................................... 107 5.1.96 PD_SetDisplayPortSetting ................................................................................ 107 5.1.97 PD_DisplayPort_UpdateStatus ...............
PAGE 11
5.2.1 PD_DelayAutoResponse ..................................................................................
PAGE 12
1 INTRODUCTION Integrated in Teledyne LeCroy’s Voyager M310C test platform, the Power Delivery exerciser supports traffic generation, including both provider and consumer device emulation. The Power Delivery exerciser continues to evolve with each software release. Be sure to check for updated software and firmware before getting started with the Exerciser.
PAGE 13
 Within the USB 3.1 tab – “Recording/Generating” option leave in ‘Analyzer Only’ mode unless you also want to run 3.1 traffic.  Use the example PD Exerciser scripts to begin testing: C:\Users\Public\Documents\LeCroy\USB Protocol Suite\Examples\Power Delivery Exerciser Example Script Behavior Source Power Negotiate VDM.updg Voyager as Source negotiates default Provider 900mA@4.5V then sends Discover-Id. Using Basic Commands. High Level Negotiate with dynamic change cap.
PAGE 14
2 Packet Templates Following Packet Templates can be used in Basic or High-Level commands as data containers. All of these messages inherited from PD_Packet packet template except those which are used as containers for Data Objects. 2.1 PD_ControlMessage Available fields for PD_ControlMessage packet template are: Field Name MessageType Reserved1 PortDataRole_Reserved2 SpecificationRevision PortPowerRole_CablePlug MessageId NumberOfDataObjects Reserved2 Extended Description Default: 0 Default: 0 Rev2.
PAGE 15
2.7 PD_PsRdyMessage PD_PsRdyMessage MessageType packet template has same fields as PD_ControlMessage but default value for is 6. 2.8 PD_GetSourceCapMessage packet template has same fields as PD_ControlMessage but default is 7. PD_GetSourceCapMessage value for MessageType 2.9 PD_GetSinkCapMessage packet template has same fields as PD_ControlMessage but default value for MessageType is 8. PD_GetSinkCapMessage 2.
PAGE 16
2.17 PD_GetStatusMsg packet template has same fields as PD_ControlMessage but default value for MessageType is 18. Applied to Power Delivery Rev3.0. PD_GetStatusMsg 2.18 PD_FRSwapMsg packet template has same fields as PD_ControlMessage but default value for is 19. Applied to Power Delivery Rev3.0. PD_FRSwapMsg MessageType 2.19 PD_SourceCapabilitiesMessage packet template contains all the fields of PD_ControlMessage but default value for MessageType is 1.
PAGE 17
2.19.3 PD_PowerDataObjectVariableSupply_Source Used as SourceCapabilitiesData for PD_SourceCapabilitiesMessage. Available fields for this packet template are: Field Name MaxCurrent_10mAUnits MinVoltage_50mVUnits MaxVoltage_50mVUnits PowerDataType Description Default: 0 Default: 0 Default: 0 Default: 2 2.19.4 PD_PowerDataObjectBatterySupply_Source Used as SourceCapabilitiesData for PD_SourceCapabilitiesMessage.
PAGE 18
2.20.2 PD_PowerDataObjectVariableSupply_Sink Used as SinkCapabilitiesData for PD_SinkCapabilitiesMessage. Available fields for this packet template are: Field Name OperationalCurrent_10mAUnits MinVoltage_50mVUnits MaxVoltage_50mVUnits PowerDataType Description Default: 0 Default: 0 Default: 0 Default: 2 2.20.3 PD_PowerDataObjectBatterySupply_Sink Used as SinkCapabilitiesData for PD_SinkCapabilitiesMessage.
PAGE 19
2.21.2 PD_RequestDataObject_Fixed_Variable_GiveBack Used as data for PD_RequestPacket. This packet template has same fields as PD_RequestDataObject_Fixed_Variable_NoGiveBack packet template, but default value for GiveBackFlag field is 1. 2.21.3 PD_RequestDataObject_Battery_NoGiveBack Used as data for PD_RequestPacket.
PAGE 20
field is 1. Following are additional data fields(fields of PD_BatteryStatusDataObject packet template) for PD_BatteryStatusMsg packet template: NumberOfDataObjects Field Name Reserved_1 InvalidBatteryReference BatteryIsPresent BatteryChargingStatus Reserved_2 BatteryPC Description Default: 0x00 Default: 0x00 Default: 0x00 Default: 0x00 Default: 0x00 Default: 0xFFFF 2.25 PD_AlertMsg Applied to Rev3.0.
PAGE 21
VDMCommandType VDMObjectPosition VDMReserved2 VDMStructuredVdmVersion VDMType VDMSVID Default: PD_VDM_COMMAND_TYPE_INITIATOR Default: 0x00 Default: 0x00 Default: PD_VDM_STRUCTURED_VERSION_2 (Rev 3.0) Default: PD_VDM_STRUCTURED_VERSION_1 (Rev 2.0) Default: PD_VDM_TYPE_STRUCTURED_VDM Default: 0x00 2.
PAGE 22
ModalOperationSupported ProductType_UFP_Cable DataCapableAsUSBDevice DataCapableAsUSBHost Default: 0x00 Default: PD_PRODUCT_TYPE_UNDEFINED Default: 0x00 Default: 0x00 2.29.2 PD_VDM_Discover_Identity_Cert_Stat_VDO Used as VDOs for PD_VDM_Discover_Identity_Response packet template. Available fields of this packet template are: Field Name CertStatVDO_XID Rsvd Description Default: 0x00 Default: 0x00 Rev2.0 only 2.29.
PAGE 23
Reserved_2 MaxVBusVoltage CableTerminationType CableLatency Reserved_3 TypeCtoTypeC_Captive Reserved_4 Version FirmwareVersion HardwareVersion Default: 0x00 Default: PD_CABLE_MAX_VBUS_20V Default: PD_CABLE_VCONN_NOT_REQUIRED Default: PD_CABLE_LATENCY_MAX_10ns Default: 0x00 Default: PD_CABLE_TYPEC_TO_TYPEC Default: 0x00 Default: PD_CABLE_PASSIVE_VDO_VERSION_1 Default: 0x00 Default: 0x00 2.29.6 PD_DiscoverIdActiveCableVdo Applied to Rev3.0 only.
PAGE 24
2.29.7.2 Revision 3.0 Field Name USBSsSignaling VBusRequired VConnRequired VConnPower Reserved Version FirmwareVersion HardwareVersion Description Default: 0x01 Default: 0x00 Default: 0x00 Default: PD_AMA_VCONN_POWER_1 Default: 0x00 Default: PD_AMA_VDO_VERSION_1 Default: 0x00 Default: 0x00 2.
PAGE 25
can be a PD_VDO packet variable which has 32bits data length. 2.33.1 PD_VDO Can be use as DiscoverModes for PD_VDM_Discover_Modes_Response packet template. Available fields of this packet template are: Field Name Data Description Default: 0x00 2.33.2 PD_VDM_DisplayPort_DiscoverMode_Vdo In response to a Discover Mode Command, the VDO assigned to the DiscoverModes field can be in type of PD_VDM_DisplayPort_DiscoverMode_Vdo packet template, if the requested VDMSVID is PD_DISPLAY_PORT_SVID(0xFF01).
PAGE 26
2.37 PD_VDM_Exit_Mode_Response packet template contains all the fields of PD_VDM_Exit_Mode_Message but default value for VDMCommandType field is PD_VDM_COMMAND_TYPE_RESPONDER_ACK. PD_VDM_Exit_Mode_Response 2.38 PD_VDM_Attention_Message packet template contains all the fields of PD_VDM_Structured_Header but default value for VDMCommand field is PD_VDM_COMMAND_ATTENTION and default value for VDMSVID field is PD_VDM_SID.
PAGE 27
2.41 PD_VDM_DisplayPort_Configure_Message packet template contains all the fields of PD_VDM_Structured_Header but default value for NumberOfDataObjects field is 2 and default value for VDMCommand field is PD_VDM_COMMAND_DISPLAYPORT_CONFIGURE and default value for VDMSVID field is PD_DISPLAY_PORT_SVID.
PAGE 28
VendorId ProductId XId FirmwareVersion HardwareVersion LoadStep IOC Reserved_1 HoldupTime LPSCompliant PS1Compliant PS2Compliant Reserved_2 LowTouchCurEPS GroundPinSupport GrndPinForProtectiveEarth Reserved_3 PeakCur1_PercentOverload PeakCur1_OverloadPeriod PeakCur1_DutyCycle PeakCur1_VBusVoltageDroop PeakCur2_PercentOverload PeakCur2_OverloadPeriod PeakCur2_DutyCycle PeakCur2_VBusVoltageDroop PeakCur3_PercentOverload PeakCur3_OverloadPeriod PeakCur3_DutyCycle PeakCur3_VBusVoltageDroop TouchTemp ExternalSup
PAGE 29
HotSwappableBattery Default: 0x00 2.46 PD_GetBatteryCapMsg Applied to Rev3.0. PD_GetBatteryCapMsg packet template contains all the fields of PD_ExtMsgHeaders but the default value of MessageType field is 3 and the default value of DataSize field is 0x01. Following are the additional fields(fields of PD_GetBatteryCapDataBlock packet template) for this packet template: Field Name BatteryCapRef Description Default: 0x00 2.47 PD_GetBatteryStatusMsg Applied to Rev3.0.
PAGE 30
Field Name VendorId ProductId ManufacturerString Description Default: 0x00 Default: 0x00 Default: null Can be initialized using a byte stream 2.51 PD_SecurityRequestMsg Applied to Rev3.0. PD_SecurityRequestMsg packet template contains all the fields of PD_ExtMsgHeaders but the default value of MessageType field is 8. Following are the additional fields for this packet template: Field Name SecurityRequestDB Description Can contain only one Security Request Data Block.
PAGE 31
2.52 PD_SecurityResponseMsg Applied to Rev3.0. PD_SecurityResponseMsg packet template contains all the fields of PD_ExtMsgHeaders but the default value of MessageType field is 9. Following are the additional fields for this packet template: Field Name SecurityResponseDB Description Can contain only one Security Response Data Block. Available SRPDB types are: PD_SRPDB_Digests, PD_SRPDB_Certificate, PD_SRPDB_ChallengeAuth, PD_SRPDB_Error 2.52.
PAGE 32
MinProtVer MaxProtVer Capabilities Rsvd CertChainHash Salt ContextHash Signature Default: 0x00 Default: 0x00 Default: 0x01 Default: 0x00 Default: { 00 Default: { 00 Default: { 00 Default: { 00 00 00 00 } 00 00 00 } 00 00 00 } 00 00 00 } 2.52.4 PD_SRPDB_Error Used as SecurityResponseDB for PD_SecurityResponseMsg packet template.
PAGE 33
3 Type-C Commands In addition to Power Delivery commands, PD Exerciser also provides a command set to manage USB Type-C connection . It includes some low level commands for manipulating voltages, capacitors and resistors as well as some high level commands that let you have SINK, SINKAS, SOURCE and DRP state machines, described in Type-C specification, with the facilities to customize different behaviors and characteristics.
PAGE 34
CC_LINE_ALL Examples Call PD_SetResistorRd( PD_ON, CC_LINE_1 ) 3.3 PD_SetResistorRa Sets resistor Ra On/Off. Format Call PD_SetResistorRa( state, line ) Parameters state Possible values: PD_ON PD_OFF line Possible values: CC_LINE_1 CC_LINE_2 CC_LINE_ALL Examples Call PD_SetResistorRa( PD_ON, CC_LINE_2 ) 3.4 PD_SetVBusCap10MicroFarad Sets the VBus Capacitor(10 Micro Farad) On/Off.
PAGE 35
PD_OFF Examples Call PD_SetVBusCap1MicroFarad( PD_ON ) 3.6 PD_SetVBus Sets VBus On/Off. Format Call PD_SetVBus( state, voltage_milli_volt ) Parameters state Possible values: PD_ON PD_OFF voltage_milli_volt The voltage which applied on VBus. Voltage should be in range of 5000 to 20500 mV. In order to apply voltages greater than 5V, the corresponding check box should be set in recording options. Examples Call PD_SetVBus( PD_ON, 5000 ) 3.7 PD_SetVConn Sets VConn On/Off.
PAGE 36
Examples Call PD_SetLoadOnVBus( PD_ON ) 3.9 PD_TerminateCCLines Terminates CC lines with the specified resistors in parameters. Format Call PD_TerminateCCLines( CC1_Resistor, CC2_Resistor ) Parameters CC1_Resistor Possible values: CC_OPEN CC_RP CC_RP_1_5 CC_RP_3_0 CC_RD CC_RA CC2_Resistor Possible values: CC_OPEN CC_RP CC_RP_1_5 CC_RP_3_0 CC_RD CC_RA Result None Examples Call PD_TerminateCCLines( CC_RP_1_5, CC_OPEN ) 3.
PAGE 37
If is set to PD_TRUE, DRP state machine starts from Unattached.SNK state instead of Unattached.SRC state. StartWithSNK Default: PD_FALSE If is set to PD_TRUE, Exerciser supports Try.SRC state machine. Default: PD_FALSE WithTrySRC If is set to PD_TRUE, Exerciser supports Try.SNK state machine. Default: PD_FALSE WithTrySNK Result None Examples $startdrp_setting = PD_Start_DRP_Settings { WithTrySRC = PD_TRUE } Call PD_SetStartDRPSetting( $startdrp_setting ) 3.
PAGE 38
Indicates advertised current level on Rp. Default: CC_RP_CUR_1_5 Indicates whether to turn on VConn or not. Default: PD_FALSE AdvertizedCurrent WithVConn Result None Examples $startsrc_setting = PD_Start_Source_Settings { WithRa = PD_TRUE } Call PD_SetStartSourceSetting( $startsrc_setting ) 3.13 PD_StartSource It starts SOURCE state machine for connecting to a Type-C device. The command is terminated if timeout occurs or the Exerciser transitions to Attached.SRC state.
PAGE 39
AdvertizedCurrent StartWithSNK AccessoryStateDuration PoweredAccessoryExitState When WithAccessory setting is PD_TRUE: indicates advertised current level on Rp. Default: CC_RP_CUR_1_5 Applies when WithAccessory setting is PD_TRUE. If is set to PD_FALSE, SINKAS state machine starts from Unattached.Accessory state instead of Unattached.SNK state. Default: PD_TRUE When WithAccessory setting is PD_TRUE: indicates the time that Execiser stays in Powered.Accessory or Audio.Accessory states.
PAGE 40
4 Basic Commands 4.1 PD_SendPacket Sends the data payload towards the device. You can customize its behavior using provided settings. Format Call PD_SendPacket(PD_Packet $send_packet, PD_SendPacketSettings $settings) Parameters $send_packet Defines the payload. Refer to Packet Templates for available packet templates. $settings Settings for sending packet. It should be inherited from PD_SendPacketSettings template.
PAGE 41
$discover_identity = PD_VDM_Discover_Identity_Message Call PD_SendPacket( $discover_identity, $send_setting ) # Send Request message ###################### $request_data = PD_RequestDataObject_Fixed_Variable_NoGiveBack { MaxOperatingCurrent_10mAUnits = 90 OperatingCurrent_10mAUnits = 90 } $request_packet = PD_RequestPacket { Data = $request_data } #calling PD_SendPacket() command using default settings $send_packet_settings = PD_SendPacketSettings Call PD_SendPacket($request_packet, $send_packet_settings)
PAGE 42
4.3 PD_SendCorruptedPacket Sends a packet towards the Unit Under Test which is corrupted intentionally. Format Call PD_SendCorruptedPacket( PD_Packet $send_payload, PD_SendCorruptedPacketSettings $send_settings ) Parameters $send_payload The payload to be sent. Refer to Packet Templates for available packet templates. $send_settings Settings for sending the corrupted payload.
PAGE 43
CorruptPaylaod4bValue CorruptPyload5bSymbolIndex CorruptPyload5bSymbolValue NoEop CorruptEop CorruptedEopSymbol bit encoding) starting from CorruptPayload4bBitOffset and length of 0x03 bits). This field will be processed if CorruptPayload4b is PD_TRUE. Default: 0x00 Byte stream. Defines the value to be replaced with the Payload (before 5-bit encoding) data. The offset and length of replacing data should be defined using CorruptPayload4bBitOffset and CorruptPaylaod4bBitLen fields.
PAGE 44
Message type to receive.
PAGE 45
PD_RESULT_OK PD_RESULT_FAILED PD_SUBRESULT_RECEIVE_TIMEOUT PD_SUBRESULT_UNEXPECTED_MSG_RECEIVED PD_SUBRESULT_HARDRESET PD_SUBRESULT_SOFTRESET Command succeeded Command failed Subresult - No packet received within specified time Subresult - Unexpected packet received Subresult - HardReset received Subresult - SoftReset received Examples #Receive source caps #################### # Wait to receive source capability. GoodCRC is sent automatically.
PAGE 46
None Result None Examples Call PD_SendHardReset() 4.7 PD_SendCableReset Sends Cable Reset and resets all the cable related states in protocol layer. Format Call PD_SendCableReset() Parameters None Result None Examples Call PD_SendCableReset() 4.8 PD_Delay Delays Exerciser execution for specified time. Format Call PD_Delay( delay_value ) Parameters delay_value Delay in micro seconds. Result None Examples #calling PD_Delay Call PD_Delay(15000) 4.
PAGE 47
DataRole Possible values: PD_PORT_DATA_ROLE_UFP PD_PORT_DATA_ROLE_DFP PowerRole Possible values: PD_PORT_POWER_ROLE_SINK PD_PORT_POWER_ROLE_SOURCE Examples Call PD_SetRoles( PD_PORT_DATA_ROLE_DFP, PD_PORT_POWER_ROLE_SOURCE ) 4.10 PD_Set Using this command you can change necessary settings or variables inside the Exerciser. Format PD_Set $PdGlobalSettings. = PD_Set $PdTimers.
PAGE 48
Pass Through cable or not. Possible values: PD_FALSE(default), PD_TRUE PDWorkingRevision Sets the Power Delivery working revision. It should be set only once in the target Exerciser Script. Its recommended to change this setting using PD_SetWorkingRevision high-level function. Possible values: PD_SPEC_REVISION_2(Default) PD_SPEC_REVISION_3 UnchunkedSupport StructuredVDMVersion Indicates whether to support sending un-chunked messages or not.
PAGE 49
tPDDebounceMin tPDDebounceMax tSinkTx tFRSwapTx tFRSwapInit tErrorRecovery Default: 10000 us Default: 20000 us Default: 18000 us Default: 110 us Default: 15000 us Default: 25000 us Result None Examples # Enables cable emulator PD_Set $PdGLOBALSETTINGS.EnableCableEmulator = PD_TRUE Main { # Sets GoodCRC timeout PD_Set $PdTimers.tReceive = 950 Call PD_WaitForDiscoverIdentity_Cable() } 4.11 IfMatched/ElseMatched Compares Exerciser settings, Received Packet Fields and Command Results to a desired value.
PAGE 50
1st_operand 1st operand should be in one of the following formats: $PdGlobalSettings. $PdResult. $.
PAGE 51
#check for result IfMatched( $PdResult.Result, PD_RESULT_OK, PD_COMPARE_EQUAL ) { Call PD_ReceivePacket( $receive_settings ) } ElseMatched( $PdResult.Result, PD_RESULT_FAILED, PD_COMPARE_EQUAL ) { Call PD_SendHardReset() } ElseMatched { $ping_msg = PD_PingMessage Call PD_SendPacket( $ping_msg, $send_setting ) } IfMatchedEnd 4.12 PD_Loop Using this command you can create a loop containing other Exerciser commands. Note - The limit for using nested PD_Loop() commands is 8.
PAGE 52
timeout Loop duration in Micro Seconds. Result None Examples $send_setting = PD_SendPacketSettings { OrderedSetType = PD_ORDERED_SET_TYPE_SOP } $ping_msg = PD_PingMessage # Sending Ping message for 200ms PD_TimerLoop(200000) { call PD_SendPacket( $ping_msg, $send_setting ) } 4.14 PD_BreakLoop Breaks the PD_Loop and PD_TimerLoop commands.
PAGE 53
Parameters None Result None Examples $send_setting = PD_SendPacketSettings { OrderedSetType = PD_ORDERED_SET_TYPE_SOP } PD_Loop(3) { $ping_msg = PD_PingMessage call PD_SendPacket( $ping_msg, $send_setting ) IfMatched( $PdResult.Result, PD_RESULT_OK, PD_COMPARE_EQUAL ) { PD_ContinueLoop() } IfMatchedEnd Call PD_SendSoftReset( PD_ORDERED_SET_TYPE_SOP ) } 4.16 PD_Stop Stops the Exerciser. Format Call PD_Stop( return_value ) Parameters return_value Value returned to Exerciser.
PAGE 54
Call PD_Disconnect() 4.18 PD_ResumeUSB2Exerciser Resumes USB2 Exerciser execution. Not intended or supported for Customer Use. Format Call PD_ResumeUSB2Exerciser() Parameters None Result None Examples Call PD_ResumeUSB2Exerciser() 4.19 PD_ReportUSB3TermStatus Reports USB3 TermStatus. Not intended or supported for Customer Use. Format Call PD_ReportUSB3TermStatus() Parameters None Result None Examples Call PD_ReportUSB3TermStatus() 4.20 PD_IncreaseMsgId Increase Message ID(Exerciser mode: DFP/UFP).
PAGE 55
Examples Call PD_IncreaseMsgId(PD_ORDERED_SET_TYPE_SOP) 4.21 PD_DecreaseMsgId Decrease Message ID(Exerciser mode: DFP/UFP). Format Call PD_DecreaseMsgId(OrderedSetType) Parameters OrderedSetType Indicates the OrderedSet type. Possible values: PD_ORDERED_SET_TYPE_SOP PD_ORDERED_SET_TYPE_SOP_PRIME PD_ORDERED_SET_TYPE_SOP_DOUBLE_PRIME Result None Examples Call PD_DecreaseMsgId(PD_ORDERED_SET_TYPE_SOP) 4.22 PD_IncreaseMsgId_Cable Increase Message ID(Exerciser mode: Cable Emulator).
PAGE 56
OrderedSetType Indicates the OrderedSet type.
PAGE 57
5 Transaction Engine™ Power Delivery Transaction Engine™ includes high level commands and auto response capability. 5.1 High Level Commands 5.1.1 PD_SetWorkingRevision Sets the Exerciser working revision along with Specification Revision. It should call once in whole Exerciser script. The default working revision is PD_SPEC_REVISION_2. Format Call PD_SetWorkingRevision( revision ) Parameters revision Indicates the target revision.
PAGE 58
AutoSpecRev AutoUnchunkedSupport Message in Negotiation sequence will be transferred using this Specification Revision. Possible values: PD_INVALID_VALUE(default) Or other user defined value. Rev3.0 only. Indicates whether the Exerciser should detect the Specification Revision automatically from Negotiation sequence or not. Possible values: PD_FALSE, PD_TRUE(default) Rev3.0 only. Indicates whether the Exerciser should detect the Un-chunked Support automatically from Negotiation sequence or not.
PAGE 59
Result None Examples local $power_data_object = PD_PowerDataObjectFixedSupply_Source { MaxCurrent_10mAUnits = 20 Voltage_50mVUnits = 250 } call PD_AddSourceCap($power_data_object) 5.1.4 PD_ResetSourceCaps Clears all Source Capabilities defined in PD Exerciser. Should be called before adding one or more source capabilities. Format Call PD_ResetSourceCaps() Parameters None Result None Examples call PD_ResetSourceCaps() 5.1.
PAGE 60
Examples call PD_NegotiatePower_Source() 5.1.6 PD_SetNegotiationSetting_Sink Applies power negotiation settings as Sink. If the user wants to change default settings for Sink Power Negotiation, must call this command before PD_NegotiatePower_Sink or PD_NegotiatePower or PD_WaitForNegotiatePower or PD_DelayAutoResponse commands to take effect. Format Call PD_SetNegotiationSetting_Sink( PD_Negotiation_Sink_Settings $settings ) Parameters $settings Should be from PD_Negotiation_Sink_Settings type.
PAGE 61
Possible values: PD_FALSE, PD_TRUE(default) Result None Examples #Set sink negotiation settings as default $settings = PD_Negotiation_Sink_Settings call PD_SetNegotiationSetting_Sink( $settings ) 5.1.7 PD_AddSinkCap Adds Sink Capabilities to PD Exerciser. Before adding a group of sink caps make sure that there is no unwanted sink cap in the list by calling PD_ResetSinkCaps command.
PAGE 62
Examples call PD_ResetSinkCaps() 5.1.9 PD_NegotiatePower_Sink Tries to establish explicit contract as Sink by sending Request message. Format Call PD_NegotiatePower_Sink() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value PD_RESULT_OK PD_RESULT_FAILED PD_SUBRESULT_RESPONSE_REJECT PD_SUBRESULT_RESPONSE_WAIT PD_SUBRESULT_MSG_NOT_RECEIVED Description Command succeeded Command failed.
PAGE 63
also (depends on the error type which has been occurred during sending or receiving data).
PAGE 64
Field Name SkipSendingPSRDY Description Defines the response type. Possible values: PD_SWAPPOWERROLE_ACCEPT(default) PD_SWAPPOWERROLE_WAIT PD_SWAPPOWERROLE_REJECT If set to PD_TRUE, PD_SwapPowerRole will not send the PS_RDY message. Possible values: SkipSwap power role.
PAGE 65
Examples call PD_SwapPowerRole() 5.1.14 PD_WaitForSwapPowerRole Waits to receive PR_Swap message and will respond to incoming messages as part of the Swap Power Role AMS. Format Call PD_WaitForSwapPowerRole() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed.
PAGE 66
Result Value Description Command succeeded. Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). PD_RESULT_OK PD_RESULT_FAILED Examples Call PD_FastRoleSwap() 5.1.16 PD_SetSwapDataRoleSetting Applies settings to Swap Data Role related commands in PD Exerciser.
PAGE 67
Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - Response not received Subresult - Reject has been received Subresult - Wait has been received Rev3.0 only.
PAGE 68
5.1.19 PD_SetSwapVConnSetting Applies settings to Swap VConn related commands in PD Exerciser. It must be called before PD_SwapVConn or PD_WaitForSwapVConn or PD_DelayAutoResponse commands to take effect. Format Call PD_SetSwapVConnSetting( PD_SwapResponse_Settings $settings ) Parameters $settings Should be from PD_SwapResponse_Settings type. Table below describes the PD_SwapResponse_Settings template and specific settings related to Swap VConn: Field Name SwapResponse Description Response type.
PAGE 69
PD_RESULT_OK Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - Response not received Subresult - Reject has been received Subresult - Wait has been received Subresult - PS_RDY not received(PD Exerciser as VCONN Source) Rev3.0 only.
PAGE 70
Parameters $settings Setting type is PD_GotoMin_Settings. Available fields of this type are: Field Name Description Wait time-out(micro second) for receiving GotoMin message. Default: PD_DEFAULT_TIMEOUT_INFINIT Indicates the response type upon receiving GotoMin message.
PAGE 71
Format Call PD_WaitForGotoMin() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - GotoMin or PS_RDY message not received. Rev3.0 only.
PAGE 72
5.1.26 PD_GetSourceCapabilities Starts GetSourceCapabilities AMS. Format Call PD_GetSourceCapabilities() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data).
PAGE 73
Subresult - Reject has been sent as request message response Rev3.0 only. Subresult - Not_Supported has been sent as response PD_SUBRESULT_RESPONSE_REJECT PD_SUBRESULT_RESPONSE_NOT_SUPPORTED Examples Call PD_WaitForGetSourceCapabilities() 5.1.28 PD_SetGetSinkCapSetting Applies settings to GetSinkCap related commands in PD Exerciser. It must be called before PD_WaitForGetSinkCapabilities or PD_DelayAutoResponse to take effect.
PAGE 74
response Examples Call PD_GetSinkCapabilities() 5.1.30 PD_WaitForGetSinkCapabilities Waits for user-defined timeout to receive Get_Sink_Cap message. It will respond to incoming messages as part of GetSinkCapabilities AMS. Format Call PD_WaitForGetSinkCapabilities() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed.
PAGE 75
Result Value Description PD_RESULT_OK PD_RESULT_FAILED Command succeeded Command failed Examples Call PD_SendBISTCarrierMode(PD_ORDERED_SET_TYPE_SOP) 5.1.32 PD_SendBISTTestData Starts BISTTestData AMS.
PAGE 76
Call PD_GetSourceCapExtended() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - No response received. Subresult - Not_Supported message received.
PAGE 77
Examples $getsrccapext_setting = PD_GetSourceCapExtented_Settings { ResponseType = PD_RESPONSE_NOT_SUPPORTED } Call PD_SetGetSrcCapExtSetting( $getsrccapext_setting ) 5.1.35 PD_WaitForGetSrcCapExtended Wait for user-defined time-out to receive Get_Source_Cap_Extended message. It will respond to incoming messages as part of GetSourceCapExtended AMS.
PAGE 78
5.1.37 PD_ResetSrcCapExtDataBlock Clears the source capabilities extended Data Block in PD Exerciser. Should be called before calling PD_SetSrcCapExtDataBlock. Format Call PD_ResetSrcCapExtDataBlock() Parameters None Result None Examples Call PD_ResetSrcCapExtDataBlock() 5.1.38 PD_GetStatus Starts the GetStatus AMS. Format Call PD_GetStatus() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command.
PAGE 79
Parameters $settings Parameter type is PD_GetStatus_Settings. Available fields for this type are: Field Names Description Wait TimeOut(micro second) to receive GetStatus message. Default: PD_DEFAULT_TIMEOUT_INFINIT Indicates response upon receiving the GetStatus message.
PAGE 80
5.1.41 PD_SetStatusDataBlock Sets the Status Data Block in PD Exerciser. It must be called before PD_WaitForGetStatus or PD_DelayAutoResponse commands to take effect. Format Call PD_SetStatusDataBlock( PD_StatusDataBlock $status_db ) Parameters $status_db Parameter type is PD_StatusDataBlock. Refer to PD_StatusMsg for available fields. Result None Examples $status_db = PD_StatusDataBlock Call PD_SetStatusDataBlock( $status_db ) 5.1.
PAGE 81
Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - No response received. Subresult - Not_Supported message received. PD_RESULT_OK PD_RESULT_FAILED PD_SUBRESULT_RESPONSE_TIMEOUT PD_SUBRESULT_RESPONSE_NOT_SUPPORTED Examples Call PD_GetBatteryStatus() 5.1.
PAGE 82
Result None Examples $getbattstatus_setting = PD_GetBatteryStatus_Settings { ResponseType = PD_RESPONSE_NOT_SUPPORTED } Call PD_SetGetBatteryStatusSetting( $getbattstatus_setting ) 5.1.46 PD_WaitForGetBatteryStatus Waits for user-defined time-out to receive Get_Battery_Status message. It will respond to incoming messages as part of GetBatteryStatus AMS.
PAGE 83
Examples $battery_status = PD_BatteryStatusDataObject Call PD_SetBatteryStatusDO( $battery_status ) 5.1.48 PD_ResetBatteryStatusDO Clears the BatteryStatus Data Object in PD Exerciser. Should be called before calling PD_SetBatteryStatusDO command. Format Call PD_ResetBatteryStatusDO() Parameters None Result None Examples Call PD_ResetBatteryStatusDO() 5.1.49 PD_Alert Starts Alert AMS.
PAGE 84
Call PD_SetAlertDO( PD_AlertDataObject $alert_do ) Parameters $alert_do Parameter type is PD_AlertDataObject. Refer to PD_AlertMsg for available fields of this type. Result None Examples $alert_do = PD_AlertDataObject Call PD_SetAlertDO( $alert_do ) 5.1.51 PD_SetAlertSetting Applies settings to Alert related commands in PD Exerciser. It must be called before PD_WaitForAlert or PD_DelayAutoResponse commands to take effect.
PAGE 85
Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - Alert message not received. Subresult - Not_Supported message sent as response.
PAGE 86
$get_battery_cap_db Parameter type is PD_GetBatteryCapDataBlock. Refer to PD_GetBatteryCapMsg for available fields of this type. Result None Examples $get_battery_cap_db = PD_GetBatteryCapDataBlock Call PD_SetGetBatteryCapDataBlock( $get_battery_cap_db ) 5.1.55 PD_SetGetBatteryCapSetting Applies settings to GetBatteryCap related commands in PD Exerciser. It must be called before PD_WaitForGetBatteryCap or PD_DelayAutoResponse to take effect.
PAGE 87
Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - Get_Battery_Cap not received. Subresult - Not_Supported message sent as response.
PAGE 88
Call PD_ResetBatteryCapDataBlock() 5.1.59 PD_GetManufacturerInfo Starts GetManufacturerInfo AMS. Format Call PD_GetManufacturerInfo( OrderedSetType ) Parameters OrderedSetType possible values: PD_ORDERED_SET_TYPE_SOP PD_ORDERED_SET_TYPE_SOP_PRIME PD_ORDERED_SET_TYPE_SOP_DOUBLE_PRIME Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed.
PAGE 89
5.1.61 PD_SetGetManufacturerInfoSetting Applies setting to GetManufacturerInfo related commands in PD Exerciser. It must be called before PD_WaitForGetManufacturerInfo or PD_DelayAutoResponse commands to take effect. Format Call PD_SetGetManufacturerInfoSetting( PD_GetManufacturerInfo_Settings $settings ) Parameters $settings Parameter type is PD_GetManufacturerInfo_Settings. Available fields of this type are: Field Names Description Wait TimeOut(in micro seconds) to receive GetManufacturerInfo message.
PAGE 90
Call PD_WaitForGetManufacturerInfo() 5.1.63 PD_SetManufacturerInfoDataBlock Sets ManufacurerInfo Data Block in PD Exerciser. It must be called before PD_WaitForGetManufacturerInfo or PD_DelayAutoResponse commands to take effect. Format Call PD_SetManufacturerInfoDataBlock( PD_ManufacturerInfoDataBlock $manufacturer_info_db ) Parameters $manufacturer_info_db Parameter type is PD_ManufacturerInfoDataBlock. Refer to PD_ManufacturerInfoMsg for available fields of this type.
PAGE 91
Format Call PD_SecurityRequest( OrderedSetType ) Parameters OrderedSetType Possible values: PD_ORDERED_SET_TYPE_SOP PD_ORDERED_SET_TYPE_SOP_PRIME PD_ORDERED_SET_TYPE_SOP_DOUBLE_PRIME Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed.
PAGE 92
Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. List of result values: Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - Security_Request message not received.
PAGE 93
Field Name DiscoverIdentityResponse WaitTimeout RetryCountOnWait RetryDelayOnWait AutoSpecRevCable Description Indicates the response type. possible values are: PD_DISCOVERIDENTITY_ACK(default) PD_DISCOVERIDENTITY_BUSY PD_DISCOVERIDENTITY_NAK Timeout(micro second) to wait for receiving Discover Identity Command Default: PD_DEFAULT_TIMEOUT_INFINIT Indicates the retry count if Wait message received as response. Default: 4 Indicates the retry delay time(micro second) if Wait message received as response.
PAGE 94
Format Call PD_ResetDiscoverIdentityVDO() Parameters None Result None Examples call PD_ResetDiscoverIdentityVDO() 5.1.72 PD_DiscoverIdentity Starts DiscoverIdentity AMS. Format Call PD_DiscoverIdentity( OrderedSetType ) Parameters OrderedSetType possible values: PD_ORDERED_SET_TYPE_SOP PD_ORDERED_SET_TYPE_SOP_PRIME PD_ORDERED_SET_TYPE_SOP_DOUBLE_PRIME Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command.
PAGE 95
Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data).
PAGE 96
5.1.75 PD_AddSvid Adds SVIDs to PD Exerciser. It must be called before PD_DiscoverSvids or PD_WaitForDiscoverSvids or PD_PerformDiscoveryProcess or PD_DelayAutoResponse commands to take effect. Note - Up to 11 SVIDs can be added using this command. Format Call PD_AddSvid(value) Parameters value SVID value to add Result None Examples call PD_AddSvid(0xFF01) 5.1.76 PD_ResetSvids Clears SVIDs which is added to PD Exerciser. Should be called before adding one or more SVID.
PAGE 97
possible values: PD_ORDERED_SET_TYPE_SOP PD_ORDERED_SET_TYPE_SOP_PRIME PD_ORDERED_SET_TYPE_SOP_DOUBLE_PRIME Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data).
PAGE 98
5.1.79 PD_SetDiscoverModeSetting Applies settings to DiscoverModes related commands in PD Exerciser. It must be called before PD_DiscoverModes or PD_WaitForDiscoverModes or PD_PerformDiscoveryProcess or PD_DelayAutoResponse commands to take effect. Format Call PD_SetDiscoverModeSetting( PD_DiscoverModes_Settings $settings ) Parameters $settings Should be from PD_DiscoverModes_Settings type.
PAGE 99
5.1.81 PD_AddModeVDO Adds Mode with VDO in PD Exerciser. It must be called before PD_DiscoverModes or PD_WaitForDiscoverModes or PD_PerformDiscoveryProcess or PD_DelayAutoResponse commands to take effect. Format Call PD_AddModeVDO(PD_Generic_VDO $ModeVdo) Parameters $ModeVdo Parameter type is PD_Generic_VDO. Refer to PD_VDM_Discover_Modes_Response for available VDOs which can be use as this parameter. Result None Examples local $vdo_1 = PD_VDO { Data = 0x01 } call PD_AddModeVDO($vdo_1) 5.1.
PAGE 100
PD_ORDERED_SET_TYPE_SOP_PRIME PD_ORDERED_SET_TYPE_SOP_DOUBLE_PRIME selectedSvid Indicates the SVID value Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data).
PAGE 101
5.1.85 PD_SetEnterModeSetting Applies settings to EnterMode related commands in PD Exerciser. It must be called before PD_WaitForEnterMode or PD_DelayAutoResponse commands to take effect. Format Call PD_SetEnterModeSetting( PD_EnterMode_Settings $settings ) Parameters $settings Should be from PD_EnterMode_Settings type. Table below describes the PD_EnterMode_Settings template: Field Name EnterModeResponse Description Response type.
PAGE 102
Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - No response received Subresult - NAK received as response PD_RESULT_FAILED PD_SUBRESULT_RESPONSE_TIMEOUT PD_SUBRESULT_RESPONSE_NAK Examples call PD_EnterMode(PD_ORDERED_SET_TYPE_SOP,0xFF00, 1) 5.1.87 PD_EnterModeVdo Starts EnterMode AMS.
PAGE 103
5.1.88 PD_WaitForEnterMode Waits for user-defined time-out to receive ENTERMODE command. It will respond to incoming messages as part of EnterMode AMS. Format Call PD_WaitForEnterMode() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. Result Value Description Command succeeded Command failed.
PAGE 104
#Using default settings $settings = PD_ExitMode_Settings call PD_SetExitModeSetting( $settings ) 5.1.90 PD_ExitMode Starts ExitMode AMS.
PAGE 105
Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data). Subresult - EXITMODE message not received Subresult - NAK has been sent as response PD_RESULT_OK PD_RESULT_FAILED PD_SUBRESULT_MSG_NOT_RECEIVED PD_SUBRESULT_RESPONSE_NAK Examples call PD_WaitForExitMode() 5.1.92 PD_Attention Starts Attention AMS.
PAGE 106
rderedSetType Indicates the ordered set type. Possible values: PD_ORDERED_SET_TYPE_SOP PD_ORDERED_SET_TYPE_SOP_PRIME PD_ORDERED_SET_TYPE_SOP_DOUBLE_PRIME selectedSvid Indicates the SVID modeId Indicates the mode index related to the specified SVID $Vdo Vendor defined data object. Should be from PD_VDO(Inherited from PD_Generic_VDO) type. Field Name Data Description VDO data Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command.
PAGE 107
None Examples #Using default settings $settings = PD_DiscoveryProcess_Settings call PD_SetDiscoveryProcessSetting( $settings ) 5.1.95 PD_PerformDiscoveryProcess Performs full discovery process. Note - PD Exerciser supports only one(first) DiscoverSVIDs Ack message (up to 12 SVIDs). Format Call PD_PerformDiscoveryProcess( OrderedSetType ) Parameters OrderedSetType Indicates the ordered set type.
PAGE 108
Object which can be used in Display Port Configure initiator message. Timeout(micro second) to wait for receiving Display Port Update Status or Configure command.
PAGE 109
Examples call PD_DisplayPort_UpdateStatus() 5.1.98 PD_DisplayPort_Configure Starts DisplayPortConfigure(Structured VDM) AMS. Format Call PD_DisplayPort_Configure() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. Result Value Description Command succeeded Command failed.
PAGE 110
Examples call PD_WaitForDisplayPortStatus() 5.1.100 PD_WaitForDisplayPortConfigure Waits for user-defined time-out to receive DisplayPort CONFIGURE command. It will respond to incoming messages as part of DisplayPortConfigure(Structured VDM) AMS. Format Call PD_WaitForDisplayPortConfigure() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. Result Value Description Command succeeded Command failed.
PAGE 111
Examples PD_Set $PdGlobalSettings.EnableCableEmulator = PD_TRUE . . #Using default settings $settings = PD_DiscoverIdentity_Settings call PD_SetDiscoverIdentitySetting_Cable( $settings ) 5.1.102 PD_WaitForDiscoverIdentity_Cable Waits for user-defined time-out to receive DISCOVERIDENTITY command. It will respond to incoming messages as part of DiscoverIdentity AMS. Note - PD Exerciser should also act as Cable Plug to be able to process this command.
PAGE 112
$vdo Parameter type is PD_DiscoverIdentity_VDO. Refer to PD_VDM_Discover_Identity_Response for available DiscoverID VDOs. Result None Examples PD_Set $PdGlobalSettings.EnableCableEmulator = PD_TRUE . . #Add a Cable VDO $vdo = PD_VDM_Discover_Identity_Cable_VDO call PD_AddDiscoverIdentityVDO_Cable( $vdo ) 5.1.104 PD_ResetDiscoverIdentityVDO_Cable Clears DiscoverIdentity VDOs(for cable) in PD Exerciser. Should be called before adding one or more DicoverIdentity VDO.
PAGE 113
Result None Examples PD_Set $PdGlobalSettings.EnableCableEmulator = PD_TRUE . . #Using default settings $settings = PD_DiscoverSvids_Settings call PD_SetDiscoverSVIDSetting_Cable( $settings ) 5.1.106 PD_WaitForDiscoverSvids_Cable Waits for user-defined time-out to receive DISCOVERSVID command. It will respond to incoming messages as part of DiscoverSVIDs AMS. Note - PD Exerciser should also act as Cable Plug to be able to process this command.
PAGE 114
Parameters value SVID value to add Result None Examples PD_Set $PdGlobalSettings.EnableCableEmulator = PD_TRUE . . call PD_AddSvid_Cable(0xFF81) 5.1.108 PD_ResetSvids_Cable Clears SVIDs(for cable) which is added to PD Exerciser. Should be called before adding one or more SVID. Note - PD Exerciser should also act as Cable Plug to be able to process this command. Format Call PD_ResetSvids_Cable() Parameters None Result None Examples PD_Set $PdGlobalSettings.EnableCableEmulator = PD_TRUE . .
PAGE 115
None Examples PD_Set $PdGlobalSettings.EnableCableEmulator = PD_TRUE . . #Using default settings $settings = PD_DiscoverModes_Settings call PD_SetDiscoverModeSetting_Cable( $settings ) 5.1.110 PD_WaitForDiscoverModes_Cable Waits for user-defined time-out to receive DISCOVERMODE command. It will respond to incoming messages as part of DiscoverModes AMS. Note - PD Exerciser should also act as Cable Plug to be able to process this command.
PAGE 116
Parameters $ModeVdo Should be from PD_Vdo type. Table below describes the PD_VDO template that can be use as ModeVdo: Field Name Description Data Result None Examples PD_Set $PdGlobalSettings.EnableCableEmulator = PD_TRUE . . local $vdo_1 = PD_VDO { Data = 0x01 } call PD_AddModeVDO_Cable($vdo_1) 5.1.112 PD_AddMode_Cable Adds Mode in PD Exerciser. It must be called before PD_WaitForDiscoverModes_Cable or PD_DelayAutoResponse commands to take effect.
PAGE 117
Parameters None Result None Examples PD_Set $PdGlobalSettings.EnableCableEmulator = PD_TRUE . . Call PD_ResetModes_Cable() 5.1.114 PD_SetEnterModeSetting_Cable Applies settings to EnterMode_Cable related commands in PD Exerciser. It must be called before PD_WaitForEnterMode_Cable or PD_DelayAutoResponse commands to take effect. Note - PD Exerciser should also act as Cable Plug to be able to process this command.
PAGE 118
User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data).
PAGE 119
Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command. Result Value Description Command succeeded Command failed. In this case corresponding sub results for PD_SendPacket and PD_ReceivePacket are valid also (depends on the error type which has been occurred during sending or receiving data).
PAGE 120
Note - PD Exerciser should also act as Cable Plug to be able to process this command. Format Call PD_SetGetManufacturerInfoSetting_Cable( PD_GetManufacturerInfo_Settings $settings ) Parameters $settings Refer to PD_SetGetManufacturerInfoSetting for more details. Result None Examples PD_Set $PdGlobalSettings.EnableCableEmulator = PD_TRUE . . $getmaninfo_setting = PD_GetManufacturerInfo_Settings { WaitTimeout = 50000 } Call PD_SetGetManufacturerInfoSetting_Cable( $getmaninfo_setting ) 5.1.
PAGE 121
Call PD_WaitForGetManufacturerInfo_Cable() 5.1.121 PD_SetSecurityResponseDataBlock_Cable Sets the SecurityResponse Data Block(for cable) in PD Exerciser. It must be called before PD_WaitForSecurityRequest_Cable or PD_DelayAutoResponse to take effect. Note - PD Exerciser should also act as Cable Plug to be able to process this command. Format Call PD_SetSecurityResponseDataBlock_Cable( PD_SecurityResponseDB $security_resp_db ) Parameters $security_resp_db Parameter type is PD_SecurityResponseDB.
PAGE 122
5.1.123 PD_WaitForSecurityRequest_Cable Waits for user-defined time-out to receive Security_Request message. It will respond to incoming messages as part of SecurityRequest AMS. Note - PD Exerciser should also act as Cable Plug to be able to process this command. Format Call PD_WaitForSecurityRequest_Cable() Parameters None Result User can evaluate the command results(including sub-results) using IfMatched/ElseMatched command.