Teledyne-lecroy Protocol Analyzers File-Based Decoding User Manual Manuel d'utilisateur

August 2011PROTOCOL SOLUTIONS GROUP3385 SCOTT BLVDSANTA CLARA, CA 95054LeCroy Protocol AnalyzersFile-Based DecodingUser Manual

Chapter 2: Values File-based Decoding User Manual4 LeCroy CorporationEscape SequencesThese are the available escape sequences in CSL:\\ "This is

File-based Decoding User Manual Chapter 2: ValuesLeCroy Corporation 52.2 VariablesVariables are used to store information, or data, that can be modif

Chapter 2: Values File-based Decoding User Manual6 LeCroy CorporationLocal VariablesLocal variables are not declared. Instead, they are created as nee

File-based Decoding User Manual Chapter 3: ExpressionsLeCroy Corporation 7Chapter 3: ExpressionsAn expression is a statement that calculates a value

Chapter 3: Expressions File-based Decoding User Manual8 LeCroy Corporation3.1 select expressionThe select expression selects the value to which it eva

File-based Decoding User Manual Chapter 4: OperatorsLeCroy Corporation 9Chapter 4: OperatorsAn operator is a symbol that represents an action, such

Chapter 4: Operators File-based Decoding User Manual10 LeCroy CorporationWhen operators of equal precedence occur in an expression, the operands are e

File-based Decoding User Manual Chapter 4: OperatorsLeCroy Corporation 11Operator Symbol Description Operand TypesResult Types ExamplesIndex Operator

Chapter 4: Operators File-based Decoding User Manual12 LeCroy CorporationEquality Operators== Equal Integer-integer Integer 2 == 2String-string Intege

File-based Decoding User Manual Chapter 4: OperatorsLeCroy Corporation 13Logical Operators! Negation All combinations of types Integer !0 = 1 !"

Document Disclaimer File-based Decoding User ManualLeCroy CorporationDocument DisclaimerThe information in this document has been carefully checked a

Chapter 4: Operators File-based Decoding User Manual14 LeCroy CorporationAssignment Operators= Assignment Any Any A = 1B = C = A+= Addition assignment

File-based Decoding User Manual Chapter 4: OperatorsLeCroy Corporation 15List Operatorssizeof() Number of elementsAny Integer sizeof([1, 2, 3]) = 3si

Chapter 4: Operators File-based Decoding User Manual16 LeCroy Corporation

File-based Decoding User Manual Chapter 5: CommentsLeCroy Corporation 17Chapter 5: CommentsComments may be inserted into scripts as a way of documen

Chapter 5: Comments File-based Decoding User Manual18 LeCroy Corporation

File-based Decoding User Manual Chapter 6: KeywordsLeCroy Corporation 19Chapter 6: KeywordsKeywords are reserved words that have special meanings wi

Chapter 6: Keywords File-based Decoding User Manual20 LeCroy Corporation

File-based Decoding User Manual Chapter 7: StatementsLeCroy Corporation 21Chapter 7: StatementsStatements are the building blocks of a program. A pr

Chapter 7: Statements File-based Decoding User Manual22 LeCroy Corporation7.3 if-else StatementsThe form for an if-else statement isif <expression&

File-based Decoding User Manual Chapter 7: StatementsLeCroy Corporation 237.5 for StatementsA for statement takes the form: for (<expression1>;

File-based Decoding User Manual Table of ContentsLeCroy Corporation iiiTABLE OF CONTENTSChapter 1 Introduction 11.1 Features of CATC Scripting Langu

Chapter 7: Statements File-based Decoding User Manual24 LeCroy Corporation7.6 return StatementsEvery function returns a value, which is usually design

File-based Decoding User Manual Chapter 7: StatementsLeCroy Corporation 25However,str = FormatEx ( "%s", HiThere() );...HiThere(){a = &

Chapter 7: Statements File-based Decoding User Manual26 LeCroy Corporation7.7 Compound StatementsA compound statement, or statement block, is a group

File-based Decoding User Manual Chapter 8: PreprocessingLeCroy Corporation 27Chapter 8: PreprocessingThe preprocessing command %include can be used

Chapter 8: Preprocessing File-based Decoding User Manual28 LeCroy Corporation

File-based Decoding User Manual Chapter 9: ContextLeCroy Corporation 29Chapter 9: ContextThe context is the mechanism by which transaction data is p

Chapter 9: Context File-based Decoding User Manual30 LeCroy Corporation

File-based Decoding User Manual Chapter 10: FunctionsLeCroy Corporation 31Chapter 10: FunctionsA function is a named statement or a group of stateme

Chapter 10: Functions File-based Decoding User Manual32 LeCroy CorporationAll parameters are passed by value, not by reference, and can be changed in

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 33Chapter 11: PrimitivesPrimitive functions are called similarly to regular

Table of Contents File-based Decoding User Manualiv LeCroy CorporationAppendix B:Bluetooth . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 11: Primitives File-based Decoding User Manual34 LeCroy CorporationFormat()Format (<format string>, <value string or integer>)Para

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 35Format Conversion CharactersThese are the format conversion characters use

Chapter 11: Primitives File-based Decoding User Manual36 LeCroy CorporationFormatEx()FormatEx (<format_string string>, <arg_list list>)Par

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 37Format Conversion Characters These are the format conversion characters us

Chapter 11: Primitives File-based Decoding User Manual38 LeCroy CorporationResolve()Resolve( <symbol_name string> )Parameter MeaningDefault Valu

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 3911.2 Data Manipulation PrimitivesGetBitOffset()GetBitOffset() Parameter Me

Chapter 11: Primitives File-based Decoding User Manual40 LeCroy CorporationGetNBits()GetNBits (<bit_source list or raw>,  <bit_offs

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 41NextNBits()NextNBits (<bit_count integer>)Parameter MeaningDefault V

Chapter 11: Primitives File-based Decoding User Manual42 LeCroy CorporationPeekNBits()PeekNBits(<bit_count integer>) Parameter MeaningDefault Va

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 4311.3 List Manipulation PrimitivesRemoveAt()RemoveAt( <list_object list,

File-based Decoding User Manual List of FiguresLeCroy Corporation vLIST OF FIGURESFigure 7.1 Execution of a for Statement . . . . . . . . . . . . .

Chapter 11: Primitives File-based Decoding User Manual44 LeCroy CorporationSetAt()RemoveAt( <list_object list, index integer> )Parameter Meaning

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 4511.4 Transaction Decoder PrimitivesAbort()Abort()Parameter MeaningDefault

Chapter 11: Primitives File-based Decoding User Manual46 LeCroy CorporationAddEvent()AddEvent(<Group string>, <Value string> ) Parameter M

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 47Complete()Complete()Parameter MeaningDefault Value CommentsSupportSupporte

Chapter 11: Primitives File-based Decoding User Manual48 LeCroy CorporationPending()Pending()Parameter MeaningDefault Value CommentsSupportSupported b

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 49Reject()Reject()Parameter MeaningDefault Value CommentsSupportSupported by

Chapter 11: Primitives File-based Decoding User Manual50 LeCroy Corporation11.5 Display PrimitivesAddCell()AddCell(<name string>, <value stri

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 51Example# Create a regular cell named Normal with a value "Cell"

Chapter 11: Primitives File-based Decoding User Manual52 LeCroy CorporationAddDataCell()AddDataCell(<data_value raw, list or integer>, <addit

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 53Example# Creates a data cell with 2 dwords (32-bit integers) of data.AddDa

List of Tables File-based Decoding User Manualvi LeCroy CorporationLIST OF TABLESTable 2.1 Examples of String Literals . . . . . . . . . . . . . . .

Chapter 11: Primitives File-based Decoding User Manual54 LeCroy CorporationAddSeparator()AddSeparator(<additional_info any>, ...)Parameter Meani

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 55BeginCellBlock()BeginCellBlock(<name string>, <value string>,

Chapter 11: Primitives File-based Decoding User Manual56 LeCroy CorporationExample# Begin the 'red' group. For clarity these cells are red:B

File-based Decoding User Manual Chapter 11: PrimitivesLeCroy Corporation 57The output of the example is: Figure 11.4 Example: Output for BeginCellBl

Chapter 11: Primitives File-based Decoding User Manual58 LeCroy CorporationEndCellBlock()EndCellBlock()Parameter MeaningDefault Value CommentsSupportS

File-based Decoding User Manual LeCroy Corporation 59Appendix A: PCI ExpressThe information in this appendix is specific to the PETracer™ analyzer.

File-based Decoding User Manual60 LeCroy Corporationcfg.decDescription: cfg.dec is a configuration data script decoder. Input Data Fieldsin.Channel:

File-based Decoding User Manual LeCroy Corporation 61io.decDescription: io.dec is an IO data script decoder.Input Data Fieldsin.Channel: Direction o

File-based Decoding User Manual62 LeCroy Corporationmem.decDescription: mem.dec is a memory data script decoder.Input Data Fieldsin.Channel: Directi

File-based Decoding User Manual LeCroy Corporation 63msg.decDescription: msg.dec is a message data script decoder.Input Data Fieldsin.Channel: Direc

File-based Decoding User Manual Chapter 1: IntroductionLeCroy Corporation 1Chapter 1: IntroductionCATC Scripting Language (CSL) was developed to cre

File-based Decoding User Manual64 LeCroy Corporation• _TLP_MSGCODE_UNLOCK• _TLP_MSGCODE_SLOTPOWERLIMIT• _TLP_MSGCODE_VENDOR0• _TLP_MSGCODE_VENDOR1•

File-based Decoding User Manual LeCroy Corporation 65atomop.decDescription: atomop.dec is an atomic operation data script decoder.Input Data Fieldsi

File-based Decoding User Manual66 LeCroy Corporationin.CompleterID: ID of the completer that completed the transactionin.HeaderData: Packet header d

File-based Decoding User Manual LeCroy Corporation 67Appendix B: BluetoothThe information in this appendix is specific to the Bluetooth analyzer. B

File-based Decoding User Manual68 LeCroy CorporationModule DataThere are several standard global variables that should be defined in a module which

File-based Decoding User Manual LeCroy Corporation 69DecoderDescOptional. A string that describes this decoder. Displays as a toolbar icon tool tip.

File-based Decoding User Manual70 LeCroy CorporationB.2 Input Context DataThe Merlin application decodes several layers of Bluetooth protocol and pr

File-based Decoding User Manual How to Contact LeCroyLeCroy Corporation 71How to Contact LeCroyType of ServiceContactCall for technical support…US a

How to Contact LeCroy File-based Decoding User Manual72 LeCroy Corporation

File-based Decoding User Manual IndexLeCroy Corporation 73 IndexSymbols# symbol 17% symbol 35%include statement 27*/ symbol 17.dec files 1, 59.inc ex

Chapter 1: Introduction File-based Decoding User Manual2 LeCroy Corporation

Index File-based Decoding User Manual74 LeCroy CorporationData Manipulation Primitives 39decimal numbers 3declare a function 31Decode Scripting files

File-based Decoding User Manual IndexLeCroy Corporation 75 in.PrepareFldsForDlg 60, 61, 62, 63, 65in.Protocol 70in.Register 60in.RequesterID 60, 61,

Index File-based Decoding User Manual76 LeCroy Corporationregular functions 33Reject function 49relational operators 12relative pathname 27RemoveAt f

File-based Decoding User Manual Chapter 2: ValuesLeCroy Corporation 3Chapter 2: ValuesThere are five value types that may be manipulated by a script