Teledyne-lecroy FireInspector Automation Application Programming I Manuel d'utilisateur

2403 Walsh Avenue, Santa Clara, CA 95051-1302 Tel: +1/408.727.6600 Fax: +1/408.727.6622Version 1.0January 11, 2002FireInspector™ AutomationApplicat

6 FireInspector Automation User’s ManualCATC Version 1.02.3.1 IAnalyzer::GetVersionRetrieves the current version of specified subsystem.SyntaxHRESULT

7 FireInspector Automation User’s ManualCATC Version 1.0ANALYZERVERSION_SOFTWARE );}catch ( _com_error& er){if (er.Description().length() > 0)

8 FireInspector Automation User’s ManualCATC Version 1.02.3.2 IAnalyzer::GetSerialNumberRetrieves serial number of analyzer device.SyntaxHRESULT GetSe

9 FireInspector Automation User’s ManualCATC Version 1.0TCHAR buffer[20];_stprintf( buffer, _T("Serial number: %X"), HIBYTE(serial_number),

10 FireInspector Automation User’s ManualCATC Version 1.02.3.3 IAnalyzer::OpenFileOpens trace file.SyntaxHRESULT OpenFile ( [in] BSTR file_name, [out,

11 FireInspector Automation User’s ManualCATC Version 1.0}// query for VTBL interfaceIFwTrace* Fw_trace;hr = trace->QueryInterface( IID_IFwTrace,

12 FireInspector Automation User’s ManualCATC Version 1.02.3.4 IAnalyzer::StartGenerationStarts traffic generation from the file.SyntaxHRESULT StartGe

13 FireInspector Automation User’s ManualCATC Version 1.02.3.5 IAnalyzer::StopGenerationStops generation.SyntaxHRESULT StopGeneration ( );ParametersR

14 FireInspector Automation User’s ManualCATC Version 1.02.3.6 IAnalyzer::StartRecordingStarts recording with specified recording options.SyntaxHRESUL

15 FireInspector Automation User’s ManualCATC Version 1.0. . . try{fw_analyzer->StartRecording( ro_file_name )}catch ( _com_error& er){if (er.

ii FireInspector Automation User’s ManualCATC Version 1.0Document DisclaimerThe information contained in this document has been carefully checked and

16 FireInspector Automation User’s ManualCATC Version 1.02.3.7 IAnalyzer::StopRecordingStops recording started by StartRecording method.SyntaxHRESULT

17 FireInspector Automation User’s ManualCATC Version 1.0{if (er.Description().length() > 0)::MessageBox( NULL, er.Description(), _T("FwAnaly

18 FireInspector Automation User’s ManualCATC Version 1.02.3.8 IAnalyzer::MakeRecordingMakes recording with specified recording options file.SyntaxHRE

19 FireInspector Automation User’s ManualCATC Version 1.0::MessageBox( NULL, er.ErrorMessage(), _T("FwAnalyzer client"), MB_OK );return 1;}

20 FireInspector Automation User’s ManualCATC Version 1.02.3.9 IAnalyzer::LoadDisplayOptionsLoads display options that will apply for trace opened or

21 FireInspector Automation User’s ManualCATC Version 1.02.3.10 IAnalyzer::GetRecordingOptionsRetrieves primary interface for access to recording opt

22 FireInspector Automation User’s ManualCATC Version 1.0hr = rec_opt->QueryInterface( IID_IFwRecOptions, (LPVOID *)&ib_rec_opt );rec_opt->R

23 FireInspector Automation User’s ManualCATC Version 1.02.3.11 IFwAnalyzer::EnableConfigROMSets config ROM that the FireInspector will return to eit

24 FireInspector Automation User’s ManualCATC Version 1.02.3.12 IFwAnalyzer::LoadConfigROMLoads the config ROM specified by filename and enables it.Sy

25 FireInspector Automation User’s ManualCATC Version 1.02.3.13 IFwAnalyzer::RetrieveTreePerforms a bus reset with a type specified in reset_type and

iii FireInspector Automation User’s ManualCATC Version 1.0TABLE OF CONTENTSTable of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . .

26 FireInspector Automation User’s ManualCATC Version 1.02.4 Primary Dual Interface for TraceIFwTrace interface is the primary interface for FwTrace o

27 FireInspector Automation User’s ManualCATC Version 1.02.4.1 ITrace::GetNameRetrieves trace name.SyntaxHRESULT GetName ( [out, retval] BSTR* trace_

28 FireInspector Automation User’s ManualCATC Version 1.02.4.2 ITrace::ApplyDisplayOptionsApplies specified display options to the trace.SyntaxHRESULT

29 FireInspector Automation User’s ManualCATC Version 1.02.4.3 ITrace::SaveSaves trace into file, allows to save a range of packets.SyntaxHRESULT Sav

30 FireInspector Automation User’s ManualCATC Version 1.0fw_trace->Save( file_name, packet_from, packet_to );}catch ( _com_error& er){if (er.De

31 FireInspector Automation User’s ManualCATC Version 1.02.4.4 ITrace::ExportToTextExports trace into text file, allows to export a range of packetsS

32 FireInspector Automation User’s ManualCATC Version 1.0_______| Data(2 quadlets) data_CRC(0x12CC63D9) ACK(pending)Idle( 61.584 µs)_______| Time Stam

33 FireInspector Automation User’s ManualCATC Version 1.0rt(X)_______| rcode(complete) header_CRC(0x2007F63C)ACK(complete) Idle( 51.719 ms)_______| T

34 FireInspector Automation User’s ManualCATC Version 1.0::MessageBox( NULL, er.Description(), _T("FwAnalyzer client"), MB_OK );else::Messa

35 FireInspector Automation User’s ManualCATC Version 1.02.4.5 ITrace::CloseCloses the trace.SyntaxHRESULT Close ( );ParametersReturn valuesRemarksCl

iv FireInspector Automation User’s ManualCATC Version 1.0IRecOptions::SetPostTriggerPercentage. . . . . . . . . . . . . . 54IRecOptions::SetTriggerBee

36 FireInspector Automation User’s ManualCATC Version 1.02.4.6 ITrace::ReportFileInfoSaves trace information into specified text file.SyntaxHRESULT Re

37 FireInspector Automation User’s ManualCATC Version 1.0C++:IFwTrace* fw_trace;TCHAR file_name[_MAX_PATH];. . . try{fw_trace->ReportFileInfo( fil

38 FireInspector Automation User’s ManualCATC Version 1.02.4.7 ITrace::ReportErrorSummarySaves trace error summary information into specified text fil

39 FireInspector Automation User’s ManualCATC Version 1.0C++:IFwTrace* fw_trace;TCHAR file_name[_MAX_PATH];. . . try{fw_trace->ReportErrorSummary(

40 FireInspector Automation User’s ManualCATC Version 1.02.4.8 ITrace::ReportTrafficSummarySaves trace traffic summary information into specified text

41 FireInspector Automation User’s ManualCATC Version 1.02.4.9 ITrace::GetPacketRetrieves raw packet representation.SyntaxHRESULT GetPacket ( [in] lo

42 FireInspector Automation User’s ManualCATC Version 1.0(TextPacketNumber.value, Packet)If Err.Number <> 0 ThenMsgBox "GetPacket:" &a

43 FireInspector Automation User’s ManualCATC Version 1.0{VARIANT var;HRESULT hr = SafeArrayGetElement(packet_safearray, &i, &var);if (FAILED

44 FireInspector Automation User’s ManualCATC Version 1.02.4.10 ITrace::GetPacketsCountRetrieves total number of packets in the trace.SyntaxHRESULT Ge

45 FireInspector Automation User’s ManualCATC Version 1.0TCHAR trace_info[256];_stprintf( trace_info, _T("Trace:'%s', total packets:%l

1 FireInspector Automation User’s ManualCATC Version 1.01. Introduction FireInspector Automation is an Application Programming Interface (API) that a

46 FireInspector Automation User’s ManualCATC Version 1.02.4.11 ITrace::GetTriggerPacketNumRetrieves trigger packet number.SyntaxHRESULT GetTriggerPac

47 FireInspector Automation User’s ManualCATC Version 1.02.4.12 ITrace::AnalyzerErrorsRetrieves trace file errors.SyntaxHRESULT AnalyzerErrors ( [in]

48 FireInspector Automation User’s ManualCATC Version 1.0client"), MB_OK );else::MessageBox( NULL, er.ErrorMessage(),_T("FwAnalyzer client&q

49 FireInspector Automation User’s ManualCATC Version 1.02.5 Primary Dual Interface for Recording OptionsIFwRecOptions interface is the primary inter

50 FireInspector Automation User’s ManualCATC Version 1.02.5.1 IRecOptions::LoadLoads recording options from specified file.SyntaxHRESULT Load ([in] B

51 FireInspector Automation User’s ManualCATC Version 1.02.5.2 IRecOptions::SaveSaves recording options into specified file.SyntaxHRESULT Save ([in]

52 FireInspector Automation User’s ManualCATC Version 1.02.5.3 IRecOptions::SetRecModeSets the recording mode.SyntaxHRESULT SetRecMode ([in] ERecModes

53 FireInspector Automation User’s ManualCATC Version 1.02.5.4 IRecOptions::SetBufferSizeSets the size of buffer to record.SyntaxHRESULT SetBufferSiz

54 FireInspector Automation User’s ManualCATC Version 1.02.5.5 IRecOptions::SetPostTriggerPercentageSets the post-trigger buffer size.SyntaxHRESULT Se

55 FireInspector Automation User’s ManualCATC Version 1.02.5.6 IRecOptions::SetTriggerBeepSets the flag indicating to make a sound when trigger occur

2 FireInspector Automation User’s ManualCATC Version 1.01.3 Setting Up Automation for Remote UseIf you intend to run automation remotely over a networ

56 FireInspector Automation User’s ManualCATC Version 1.02.5.7 IRecOptions::SetDataTruncateSets the flag indicating that recorded data is to be trunca

57 FireInspector Automation User’s ManualCATC Version 1.02.5.8 IRecOptions::SetSaveExternalSignalsSets the flag indicating to save external signals.S

58 FireInspector Automation User’s ManualCATC Version 1.02.5.9 IRecOptions::SetTraceFileNameSets the path to the file where trace will be stored after

59 FireInspector Automation User’s ManualCATC Version 1.02.5.10 IRecOptions:: SetFilterPolaritySets the whether to filter in or out the recording eve

60 FireInspector Automation User’s ManualCATC Version 1.02.5.11 IRecOptions::ResetResets recording options to its initial state.SyntaxHRESULT Reset (

61 FireInspector Automation User’s ManualCATC Version 1.02.6 Errors Collection InterfaceThe IAnalyzerErrors dispinterface is a standard collection in

62 FireInspector Automation User’s ManualCATC Version 1.02.6.1 IAnalyzerErrors::get_ItemRetrieves an Analyzer error. Use IAnalyzerErrors::get_Count to

63 FireInspector Automation User’s ManualCATC Version 1.02.6.2 IAnalyzerErrors::get_CountRetrieves the number of Analyzer errors. Use IAnalyzerErrors

64 FireInspector Automation User’s ManualCATC Version 1.0{analyzer_error = analyzer_errors->GetItem(i);TCHAR cur_error[32];_stprintf( cur_error, _T

65 FireInspector Automation User’s ManualCATC Version 1.02.7 Analyzer Events Callback InterfaceThe _IAnalyzerEvents interface is a standard COM event

3 FireInspector Automation User’s ManualCATC Version 1.02. FireInspector Automation APIThis chapter describes the commands in the FireInspector Autom

66 FireInspector Automation User’s ManualCATC Version 1.02.7.1 IAnalyzerEvents dispinterfaceIn order to retrieve the events from FireInspector applica

67 FireInspector Automation User’s ManualCATC Version 1.02.7.2 IAnalyzerEvents::OnTraceCreatedFired when trace is created; this event is a result of

68 FireInspector Automation User’s ManualCATC Version 1.0::MessageBox( NULL, er.Description(), _T("FwAnalyzer client"), MB_OK );else::Messag

69 FireInspector Automation User’s ManualCATC Version 1.02.7.3 _IAnalyzerEvents::OnStatusReportFired when there is a change in analyzer's state

70 FireInspector Automation User’s ManualCATC Version 1.0Select Case StateCase -1: GetRecordingStatus = "Idle"Case 0: GetRecordingStatus =

71 FireInspector Automation User’s ManualCATC Version 1.0{switch ( subsystem ){case RECORDING_PROGRESS_REPORT:UpdateRecStatus( state, percent_done );

72 FireInspector Automation User’s ManualCATC Version 1.0break;case FW_ASR_SYNC_STATE_SYNCING: _tcscpy( m_SyncStatus, _T("Syncing...") );bre

73FireInspector Automation API User’s ManualCATC Version 1.0Appendix A: Setting Up FireInspector AutomationFireInspector Automation is an Applicatio

74FireInspector Automation API User’s ManualCATC Version 1.0A.3 Setting Up Automation for Remote UseIf you intend to run automation over a network, yo

75FireInspector Automation API User’s ManualCATC Version 1.0Step 2 In the Open edit box within the Run dialog, type dcomcnfg.Step 3 Click OK.The Dist

4 FireInspector Automation User’s ManualCATC Version 1.02.2 Command DescriptionsThe following descriptions are organized into five sections that corre

76FireInspector Automation API User’s ManualCATC Version 1.0Step 2 Click the Properties button.The FwAnalyzer Properties dialog box opens. The options

77FireInspector Automation API User’s ManualCATC Version 1.0Set Access PermissionsAccess permission determines who may execute commands on the applic

78FireInspector Automation API User’s ManualCATC Version 1.0The Registry Value Permissions dialog box appears.Step 4 Click the Add... button.The Add U

79FireInspector Automation API User’s ManualCATC Version 1.0The Add Users and Groups dialog appears.Step 4 Select the group called Everyone.If you pr

80FireInspector Automation API User’s ManualCATC Version 1.0Set User Identity PermissionsIf you want to create password-based security for individual

81FireInspector Automation API User’s ManualCATC Version 1.0A.5 DCOM Client ConfigurationTo configure the DCOM client, run the DCOM configuration uti

82FireInspector Automation API User’s ManualCATC Version 1.0Set Server LocationYou need to identify the device upon which the client will be executing

83FireInspector Automation API User’s ManualCATC Version 1.0Step 2 Select the option Enable Distributed COM on this computer.Step 3 Set the Default A

84FireInspector Automation API User’s ManualCATC Version 1.0and press OK. The protocol will be added to the bottom of the list of DCOM Protocols. Use

85FireInspector Automation API User’s ManualCATC Version 1.0Note If you prefer, you can copy the executable to the remote computer’s hard drive and l

5 FireInspector Automation User’s ManualCATC Version 1.02.3 Primary Dual Interface for AnalyzerThe IFwAnalyzer interface derives from IAnalyzer inter

86FireInspector Automation API User’s ManualCATC Version 1.0These messages indicate that a connection has been established with the FireInspector host

87FireInspector Automation API User’s ManualCATC Version 1.0Appendix B: How to Contact CATCAppendix C: Warranty and LicenseComputer Access Technolo

88FireInspector Automation API User’s ManualCATC Version 1.0