LeCroy Conquest Manual Download Page 41

Page: 41 / 48

API Constants

Data Packet Type definitions

API_MAX_TRIG_DATA_PACKET_TYPES

API_DATA_PACKET_TYPE_ANY

API_DATA_PACKET_TYPE_DATA0

API_DATA_PACKET_TYPE_DATA1

API_DATA_PACKET_TYPE_DATA2

API_DATA_PACKET_TYPE_MDATA

Timing Analyzer Pattern Type definitions

API_MAX_TA_PATTERN_TYPES

API_TA_FLS_TRIG_PATTERN_DP

0 //Full/Low Speed D+ Pattern

API_TA_FLS_TRIG_PATTERN_DM

1 //Full/Low Speed D- Pattern

API_TA_FLS_TRIG_PATTERN_RCV

2 //Full/Low Speed RCV Pattern

API_TA_HS_TRIG_PATTERN_DP

3 //High Speed D+ Pattern

API_TA_HS_TRIG_PATTERN_DM

4 //High Speed D- Pattern

Capturing Items definitions

API_MAX_CAPTURE_ITEMS

API_CAP_NO_CAPTURE

0 //None

API_CAP_ANY

1 //Everything

API_CAP_ANY_TRANS

2 //Any Transactions

API_CAP_SETUP_TRANS

API_CAP_ASYNC_IN_TRANS

API_CAP_ASYNC_OUT_TRANS

API_CAP_PING_TRANS

API_CAP_SETUP_SPLIT_TRANS

API_CAP_BULK_IN_SPLIT_TRANS

API_CAP_BULK_OUT_SPLIT_TRANS

API_CAP_INT_IN_SPLIT_TRANS

API_CAP_INT_OUT_SPLIT_TRANS

API_CAP_ISO_IN_SPLIT_TRANS

API_CAP_ISO_OUT_SPLIT_TRANS

API_CAP_SETUP_PREAMBLE_TRANS

API_CAP_ASYNC_IN_PREAMBLE_TRANS

API_CAP_ASYNC_OUT_PREAMBLE_TRANS

Summary of Contents for Conquest

Page 1: ...For Software Version 7 40 September 2008 PROTOCOL SOLUTIONS GROUP 3385 SCOTT BLVD SANTA CLARA CA 95054 Conquest Application Program Interface API Manual Version 7 40 ...

Page 2: ...rks of Microsoft Corporation Borland and Delphi are trademarks of Borland Corporation All other trademarks and registered trademarks are property of their respective owners Copyright Copyright 2008 LeCroy Corporation All rights reserved This document may be printed and reproduced without additional permission but all copies should contain this copyright notice Part number 400 0066 001 WEEE Program...

Page 3: ...ce 3 AttachToDevice 4 GetDeviceIDList 4 DetachDevice 4 SaveSmpAsText 4 IusbEasyDataCapturePrj Interface 5 GetCaptureAndTrigger 6 GetExerciser 6 GetSetting 6 Open 6 Save 7 Run 7 Stop 7 SetAnalyzerType 7 GetAnalyzerType 8 SetPAOutFile 8 GetPAOutFile 8 SetTAOutFile 8 GetTAOutFile 8 SetPreTrigger 9 GetPreTrigger 9 SetEntireMemory 9 IsSetEntireMemory 9 SetSamplesNo 9 GetSamplesNo 10 SetRunExerciser 10 ...

Page 4: ...7 ExcludeNakedTransactions 17 IsExcludeNakedTransactions 18 ExcludeNYETedTransactions 18 IsExcludeNYETedTransactions 18 ExcludeKeepAliveEvents 18 IsExcludeKeepAliveEvents 18 ExcludeSOFPackets 19 IsExcludeSOFPackets 19 SetTimingPattern 19 GetTimingPattern 19 IExerciser 20 AddCommand 21 AddUserDefineCommand 22 InsertCommand 23 InsertUserDefineCommand 24 DeleteCommand 24 DeleteAllCommands 25 SetStart...

Page 5: ...3 IsEnableHighSpeedTestMode 33 SetInfiniteExerciserLoopCounter 33 IsInfiniteExerciserLoopCounter 33 API Constants 34 Analyzer Type definitions 34 Analyzer Speed definitions 34 Trigger Items definitions 34 Data Packet Type definitions 35 Timing Analyzer Pattern Type definitions 35 Capturing Items definitions 35 Exerciser Command Type definitions 36 HUB Features definitions 36 HUB Port Features defi...

Page 6: ...Contents vi Endpoint Direction Definitions 38 Exerciser Start With event definition 38 API Errors 39 Exerciser Command Parameters 40 ...

Page 7: ...ft Visual Basic Using the Library To use the library 1 Copy the Conquest SystemData folder into the system32 folder of the Windows directory of the PC 2 Import usb tlb into your software project 3 Create a dispatch USBGeneralServices interface See page 2 4 Create a dispatch USBEasyDataCapturePrj interface See page 5 5 Use the API functions for required settings Note You must run the Conquest Suite...

Page 8: ...ecifies hardware stop flag Return Value Zero if the IsHardwareStoped was successful Otherwise non zero Each non zero value indicates an error code Remark This function sets bIsStoped to TRUE if hardware is stopped Otherwise sets to FALSE Returns error code if an error occurs See Also API Errors Method Description SetPort Set hardware attached port IsHardwareStoped Is hardware stopped SaveOutFiles ...

Page 9: ...Declaration BOOL IsEnableProtocolError short sProtocolErrorType Input s sProtocolErrorType specifies the type of protocol error Valid types are introduced in API Constants Return Value Zero if IsEnableProtocolError was successful Otherwise non zero Each non zero value indicates an error code Remark Returns true if protocol error tspecified by sProtocolErrorType is enabled Otherwise it returns fals...

Page 10: ...2D8 0400000E85000131 Remark This method enumerates all available devices on the selected port and returns available device IDs in string format DetachDevice Declaration long DetachDevice Input s None Return Value Zero if the DetachDevice was successful Otherwise non zero Each non zero value indicates an error code Remark This function detaches the device from the analyzer See Also API Errors SaveS...

Page 11: ...Stop Stop easy capture project SetAnalyzerType Set analyzer type GetAnalyzerType Get analyzer type SetPAOutFile Set Protocol Analyzer output file name GetPAOutFile Get Protocol Analyzer output file name SetTAOutFile Set Timing Analyzer output file name GetTAOutFile Get Timing Analyzer output file name SetPreTriggger Set pre trigger value GetPreTriggger Get pre trigger value SetEntireMemmory Set us...

Page 12: ...iser interface Remark Returns interface of Exerciser object Do not use CreateDispatch to create Exerciser interface GetSetting Declaration ISetting GetSetting Input s None Return Value Setting interface Remark Returns interface of Setting object Do not use CreateDispatch to create Setting interface Open Declaration long Open LPCTSTR strFilePath Input s strFilePath specifies path to a file Return V...

Page 13: ... zero Each non zero value indicates an error code Remark Checks data entries before run and runs easy data capture project See Also API Errors Stop Declaration long Stop Input s None Return Value Zero if project can stop Otherwise non zero Each non zero value indicates an error code Remark Stops easy data capture project See Also API Errors SetAnalyzerType Declaration long SetAnalyzerType short sA...

Page 14: ...e of protocol analyzer output file See Also API Errors GetPAOutFile Declaration CString GetPAOutputFile Input s None Return Value Protocol Analyzer output file name Remark Specifies name of protocol analyzer output file SetTAOutFile Declaration long SetTAOutputFile LPCTSTR strTAOutputFile Input s strTAOutputFile specifies timing analyzer output file name Return Value Error code or zero no error Re...

Page 15: ...ireMemory BOOL bEntireMemory Input s bEntireMemory sets entire the memory for capturing Output s None Return Value Error code or zero no error Remark If set to TRUE the system uses entire installed memory Otherwise it uses number specified by SamplesNo IsSetEntireMemory Declaration BOOL IsSetEntireMemory Input s None Return Value Use entire memory flag status Remark Reports if entire memory flag i...

Page 16: ...e SetRunExerciser Declaration void SetRunExerciser BOOL bRun Input s bRun sets the run exerciser flag Outputs s None Remark If set to TRUE exerciser also runs If set to FALSE only analyzer runs IsSetRunExerciser Declaration BOOL IsSetRunExerciser Input s None Return Value Run exerciser flag status Remark If set to TRUE exerciser is set to run If it set to FALSE only analyzer is set to run ...

Page 17: ... device address GetTriggerDeviceAddress Get trigger device address SetTriggerEndPoint Set trigger endpoint GetTriggerEndPoint Get trigger endpoint SetTriggerDataPacket Set trigger data packet type GetTriggerDataPacket Get trigger data packet type SetDataCapture1 Set data capture item 1 GetDataCapture1 Get data capture item 1 SetDataCapture2 Set data capture item 2 GetDataCapture2 Get data capture ...

Page 18: ...object on which the hardware is set to trigger Remark Returns trigger type SetManualTrig Declaration void SetManualTrig BOOL bManualTrig Input s bManualTrig sets use of manual trigger in place of trigger type Return Value None Remark Sets the hardware to respond to manual trigger IsSetManualTrig Declaration BOOL IsSetManualTrig Input s None Return Value Status of manual trig flag Remark Reports if...

Page 19: ... Also API Errors GetTriggerDeviceAddress Declaration CString GetTriggerDeviceAddress Input s None Return Value Device address of trigger item Length of this parameter is 7 characters in binary mode where each character is one of 0 1 x or X as do not care Remark Returns device address of trigger item SetTriggerEndPoint Declaration long SetTriggerEndPoint LPCTSTR strEndPoint Input s strEndPoint spec...

Page 20: ...type and data of data packet on which to trigger Note To trigger on data packet set trigger type to data packet by calling the SetTrigger function with the API_TRIG_DATA_PACKETS parameter See Also API Errors GetTriggerDataPacket Declaration void GetTriggerDataPacket short sDataPacketType BSTR strData BOOL bIsDataBlock Input s sDataPacketType specifies data packet type strData specifies data of dat...

Page 21: ...h to capture Type of data can be a value specified in the Data Capture combo box in the Easy data capture page If type of data is set to everything or any transaction the given device address and endpoint number do not have any effect See Also API Errors GetDataCapture1 Declaration void GetDataCapture1 short sCaptureType BSTR strDeviceAddress BSTR strEndPoint Input s sCaptureType specifies type of...

Page 22: ...ich to capture Type of data can be a value specified in the Data Capture combo box on the Easy data capture page If type of data is set to everything or any transaction the given device address and endpoint number do have not any effect See Also API Errors GetDataCapture2 Declaration void GetDataCapture2 short sCaptureType BSTR strDeviceAddress BSTR strEndPoint Input s sCaptureType specified type ...

Page 23: ...f data is set to everything or any transaction the given device address and endpoint number do have not any effect See Also API Errors GetDataCapture3 Declaration void GetDataCapture3 short sCaptureType BSTR strDeviceAddress BSTR strEndPoint Input s sCaptureType specifies type of capture item 3 Valid capture item types arein API Constants strDeviceAddress specifies device address of capture item i...

Page 24: ...ctions if FALSE IsExcludeNYETedTransactions Declaration BOOL IsExcludeNYETedTransactions Input s None Return Value Status of exclude NYET ed transactions flag Remark Returns TRUE if exclude NYETed transactions flag is selected Returns FALSE if not ExcludeKeepAliveEvents Declaration void ExcludeKeepAliveEvents BOOL bExclude Input s bExclude sets exclude KeepAlive events flag Return Value None Remar...

Page 25: ...Type LPCTSTR strPattern Input s sPatternType sets timing analyzer pattern type Valid types are in API Constants StrPattern sets timing analyzer pattern Length of this pattern for full speed patterns is eight characters and for high speed patterns is four characters Each character can be 0 1 x or X Return Value Error code or zero no error Remark Sets timing patterns for timing analyzer See Also API...

Page 26: ...d Add exerciser user defined command InsertCommand Insert exerciser command InsertUserDefineCommand Insert exerciser user defined command DeleteCommand Delete exerciser command DeleteAllCommands Delete allexerciser commands SetStartOfLoop Set exerciser command to start of loop SetEndOfLoop Set exerciser command to end of loop SetRepeatCommand Set exerciser command to repeat FindDevice Find attache...

Page 27: ... device Valid command types are in API Constants sDeviceIndex sets the found device index vtParam1 sets the first parameter of exerciser command vtParam2 sets the second parameter of exerciser command vtParam3 sets the third parameter of exerciser command Return Value Error code or zero no error Remark Adds a command to exerciser program A command can use none one or more parameters defined in Exe...

Page 28: ... of the endpoint Valid endpoint type arein API Constants sCommandType sets the exerciser command type that you want to send to the device Valid command types are in API constants sDeviceIndex specifies device index vtParam1 specifies the first parameter of the exerciser command vtParam2 specifies the second parameter of the exerciser command vtParam3 specifies the third parameter of the exerciser ...

Page 29: ...ommand type that you want to send to the device Valid types are defined in API Constants sDeviceIndex sets device index vtParam1 sets first parameter of the exerciser command vtParam2 sets second parameter of the exerciser command vtParam3 sets third parameter of the exerciser command Return Value Error code or zero no error Remark Adds a command to the exerciser program A command can use none one...

Page 30: ...andType sets exerciser command type that you want to send to the device Valid types are defined in API Constants sDeviceIndex sets device index vtParam1 sets first parameter of the exerciser command vtParam2 sets second parameter of the exerciser command vtParam3 sets third parameter of the exerciser command Return Value Error code or zero no error Remark Adds a user defined command to the exercis...

Page 31: ...nd with Index as start of a loop See Also API Errors SetEndOfLoop Declaration long SetEndOfLoop short sCommandIndex long bSet Input s sCommandIndex sets index of exerciser command bSet sets status of end of loop flag of exerciser command Return Value Error code or zero no error Remark Sets a specified command with Index as end of a loop See Also API Errors SetRepeatCommand Declaration long SetRepe...

Page 32: ...ts index of device sEndPointsNo sets the number of endpoints of the device and fills in the function if the device index exists Return Value Error code or zero no error Remark This function fills sEndPointsNo if the passed device index exists See Also API Errors GetEndPointType Declaration long GetEndPointType short sDeviceIndex short sEndPointIndex short sEndpointType Input s sDeviceIndex sets in...

Page 33: ...Index short sEndPointIndex short sEndpointNo Input s sDeviceIndex specifies the index of found device sEndPointIndex specifies the index of endpoint of a found device sEndpointNo specifies the number of the specified endpoint This parameter fills if device index and endpoint index exist Return Value Error code or zero no error Remark This function fills sEndpointNo if passed device index and endpo...

Page 34: ...rtExerciserWith short sEventType Input s sEventType specifies type of event with which the exerciser starts Valid types are in API Constants Return Value Error code or zero no error Remark This function sets the type of exerciser start event See Also API Errors ...

Page 35: ...unter Get exerciser loop counter SetExternalTriggerType Set external trigger type GetExternalTriggerType Get external trigger type EnableNonStdClock Enable non standard clock IsEnableNonStdClock Is non standard clock enabled SetNonStdClockRateType Set non standard clock rate type GetNonStdClockRateType Get non standard clock rate type EnableSecondPort Enable second port IsEnableSecondPort Is secon...

Page 36: ...lyzer Valid analyzer speed types are defined in API Constants Remark This function returns the speed of the analyzer SetExerciserLoopCounter Declaration long SetExerciserLoopCounter short sLoopCounter Input s sLoopCounter sets loop counter of exerciser This value can be between 2 and 255 Return Value Zero if the SetExerciserLoopCounter was successful Otherwise non zero Each non zero value indicate...

Page 37: ... See Also API Errors EnableNonStdClock Declaration void EnableNonStdClock BOOL bEnable Input s bEnable sets status of non standard clock flag Return Value None Remark This function enables disables the non standard clock IsEnableNonStdClock Declaration BOOL IsEnableNonStdClock Input s None Return Value Status of the non standard clock flag Remark This function returns the non standard clock status...

Page 38: ... Return Value TRUE if second port is enabled Otherwise returns FALSE Remark This function returns status of second port SetSecondPortStore Declaration long SetSecondPortStore short sStoreType Input s sStoreType sets the second port store type Valid types are defined in API Constants Return Value Zero if the SetSecondPortStore was successful Otherwise non zero Each non zero value indicates an error...

Page 39: ...st mode flag Remark This function returns the status of the high speed test mode flag SetInfiniteExerciserLoopCounter Declaration void SetInfiniteExerciserLoopCounter BOOL bInfinite Input s bInfinite sets exerciser loop counter to infinite or finite value Return Value None Remark This function sets the exerciser loop counter to infinite or finite count IsInfiniteExerciserLoopCounter Declaration BO...

Page 40: ...TRIG_ITEMS 26 API_TRIG_SNAP_SHOT 0 API_TRIG_ANY_TRANS 1 API_TRIG_DATA_PACKETS 2 API_TRIG_BUS_RESET 3 API_TRIG_RESUME 4 API_TRIG_SUSPEND 5 API_TRIG_CHIRP 6 API_TRIG_HNP 7 API_TRIG_SRP 8 API_TRIG_SESSION 9 API_TRIG_PE 10 Protocol Error API_TRIG_SETUP_TRANS 11 API_TRIG_IN_TRANS 12 API_TRIG_OUT_TRANS 13 API_TRIG_PING_TRANS 14 API_TRIG_SETUP_SPLIT_TRANS 15 API_TRIG_BULK_IN_SPLIT_TRANS 16 API_TRIG_BULK_...

Page 41: ...tern API_TA_HS_TRIG_PATTERN_DP 3 High Speed D Pattern API_TA_HS_TRIG_PATTERN_DM 4 High Speed D Pattern Capturing Items definitions API_MAX_CAPTURE_ITEMS 17 API_CAP_NO_CAPTURE 0 None API_CAP_ANY 1 Everything API_CAP_ANY_TRANS 2 Any Transactions API_CAP_SETUP_TRANS 3 API_CAP_ASYNC_IN_TRANS 4 API_CAP_ASYNC_OUT_TRANS 5 API_CAP_PING_TRANS 6 API_CAP_SETUP_SPLIT_TRANS 7 API_CAP_BULK_IN_SPLIT_TRANS 8 API_...

Page 42: ... API_EXR_COMMAND_GET_HUB_TT_STATUS 14 API_EXR_COMMAND_STOP_HUB_TT 15 API_EXR_COMMAND_DATA_IN 16 API_EXR_COMMAND_DATA_OUT 17 HUB Features definitions API_MAX_HUB_FEATURES 2 API_HUB_FEATURE_LOCAL_POWER 0 API_HUB_FEATURE_OVER_CURRENT 1 HUB Port Features definitions API_MAX_HUB_PORT_FEATURES 9 API_HUB_FEATURE_CONNECTION 0 port connection API_HUB_FEATURE_ENABLE 1 port enable API_HUB_FEATURE_SUSPEND 2 p...

Page 43: ...gger on level one of signal API_EXT_TRG_LEVEL_0 2 Trigger on level zero of signal API_EXT_TRG_EDGE_P 3 Trigger on positive edge of signal API_EXT_TRG_EDGE_N 4 Trigger on negative edge of signal Non Standard Clock Rate Type definitions API_MAX_NON_STD_CLOCK_RATE_TYPES 5 API_NON_STD_CLOCK_RATE _125K 0 API_NON_STD_CLOCK_RATE _250K 1 API_NON_STD_CLOCK_RATE _500K 2 API_NON_STD_CLOCK_RATE _1M 3 API_NON_...

Page 44: ...nous API_ENDPOINT_TYPE_BULK 2 API_ENDPOINT_TYPE_INT 3 interrupt Endpoint Direction Definitions API_MAX_ENDPOINT_DIRECTIONS 3 API_DATA_DIRECTION_NONE 0 API_DATA_DIRECTION_IN 1 API_DATA_DIRECTION_OUT 2 Exerciser Start With event definition API_MAX_EXRCISER_START_WITH_EVENTS 2 API_EXR_START_WITH_RESUME 0 API_EXR_START_WITH_RESET 1 ...

Page 45: ... 20 IDE_NO_MATCH_EXCLUDE_NYET_WITH_ANALYZER_SPEED 21 IDE_NO_MATCH_EXCLUDE_KEEPALIVE_WITH_ANALYZER_SPEED 22 DE_NO_MATCH_EXCLUDE_KEEPALIVE_WITH_TRIG_OR_CAP_ITEMS_SPEED 23 IDE_NO_MATCH_EXCLUDE_NYET_WITH_TRIG_OR_CAP_ITEMS_SPEED 24 IDE_NO_MATCH_EXCLUDE_NAK_WITH_TRIG_ITEMS 25 IDE_NO_MATCH_EXCLUDE_NYET_WITH_TRIG_ITEMS 26 IDE_NO_MATCH_EXCLUDE_SOF_OR_KEEP_ALIVE_WITH_CAP_ITEMS 27 IDE_NO_MATCH_CAPTURE_ITEM0_...

Page 46: ...no parameters These commands do not use vtParam1 vtParam2 and vtParam3 API_EXR_COMMAND_GET_CONFIGURATION API_EXR_COMMAND_GET_INTERFACE API_EXR_COMMAND_GET_HUB_CLASS_DESCRIPTOR API_EXR_COMMAND_GET_HUB_STATUS API_EXR_COMMAND_CLEAR_HUB_TT_BUFFER API_EXR_COMMAND_GET_HUB_TT_STATUS API_EXR_COMMAND_STOP_HUB_TT ...

Page 47: ...re in API Constants API_EXR_COMMAND_CLEAR_HUB_PORT_FEATURE vtParam1 should be a short variable that identifues selector type Valid selectors are in API Constants vtParam2 should be a short variable that identifies port number API_EXR_COMMAND_SET_HUB_ PORT_FEATURE vtParam1 should be a short variable that identifies selector type Valid selectors are in API Constants vtParam2 should be a short variab...

Page 48: ...Exerciser Command Parameters 42 ...

Search results

Summary of Contents for Conquest

Reviews:

Related manuals for Conquest

Brands by name

Popular brands

LeCroy Conquest, Manual

Search results

Summary of Contents for Conquest

Reviews:

Related manuals for Conquest

Brands by name

Popular brands