SPI TCL Library User's Guide Revision Jan-12 1/24

Transcription

1 Revision Jan-12 1/24 Byte Paradigm

2 Table of Content 1 Introduction TCL Interpreter Starting a TCL Session Getting Information on TCL Procedures SPI interface signals SPI Library - SPITclLib Quick Reference Table Procedures Detailed Description Table of Tables Table 1: Quick reference table of SPI procedures... 9 Table 2 : Access length according to access type and SS edges positioning Table of Pictures Figure 1: Tcl session start-up example... 5 Figure 2: Tcl console shortcut in 8PI Control Panel program group... 6 Figure 3: Tcl console at startup... 6 Revision Jan /24

3 References [1] GP complete data sheet (ds_gp22050.pdf) This document contains all the technical characteristics of the GP device. [2] 8PI Control Panel SPI mode of operation user s guide History Version Date Description Dec-2006 Initial revision Jan-2007 Added analyser functions Feb-2007 Reviewed and corrected document May-2007 Review before release Sep-2007 Modified SetReqClock and SetSSEdge functions description Nov-2007 Update for SPI Xpress Oct-2008 Added IdleBurst function Sept-2009 Update for version 1.07a of 8PI Control Panel Feb-2010 Review for release 1.08f July-2010 Corrected accesses length Completed some functions description July-2010 Updated info about max. access length in SPI Oct-2010 Removed obsolete ShiftWr and ShiftWrBurst functions Jan-2012 Added IO voltage selection Revision Jan /24

4 1 Introduction The objective of this document is to list and describe all the TCL procedures available in the SPI library provided to control the SPI operating mode of the GP and Xpress Series devices. Each procedure functionality and parameters are described in detail. A section is also dedicated to the TCL interpreter provided with the 8PI Control Panel application. The way to start it and to use it is briefly described. Revision Jan /24

5 2 TCL Interpreter 2.1 Starting a TCL Session To start a TCL session from the 8PI Control Panel GUI: 1. From the 8PI Control Panel GUI, access the desired operating mode sheet. 2. Click on the Open Tcl Console button (Figure 1). This opens the Tcl console, loads the Tcl libraries relative to the chosen operating mode and initialises the Tcl session. Figure 1: Tcl session start-up example Open Tcl Console button Revision Jan /24

6 To start a stand-alone TCL session (without running GUI): 1. From the Byte Paradigm > 8PI Control Panel program group, click on the TCL Console shortcut. This starts the Wish84 interpreter with the tkcon console. 2. In the Tcl console, type: % source SPIITclLib.tcl This initialises your TCL session in SPI operating mode. Figure 2: Tcl console shortcut in 8PI Control Panel program group Tcl Console shortcut By default, the 8PI Control Panel software environment uses the WISH interpreter with the TKCON console (interactive mode) ( Figure 3). For more information about the TKCON console, please check the following links: Please note that TCL is case sensitive. Figure 3: Tcl console at startup Loaded library TCL console prompt Tcl and Tk versions Revision Jan /24

7 2.2 Getting Information on TCL Procedures Tcl provides built-in commands for getting information about the elements loaded in memory during a Tcl session. We simply describe a few of them for those unfamiliar to the Tcl language. To list the libraries loaded in the TCL environment: % info loaded To list all the procedures loaded in the TCL environment: % info procs To list the arguments of a given procedure: % info args <procedure name> To list the body of a given procedure: % info body <procedure name> To learn more about the TCL/TK language, numerous man pages, tutorials and references can be found at the following location: Revision Jan /24

8 3 SPI interface signals Please refer to SPI Xpress / GP Series devices data sheet for pin mappings. Revision Jan /24

9 4 SPI Library - SPITclLib This library contains all the procedures available to control the GP Series devices when operating in SPI mode and the SPI Xpress device. 4.1 Quick Reference Table Table 1 gives a list of all procedures available for the ADWG mode. Table 1: Quick reference table of SPI procedures Procedures Description Terminate {} Closes the SPI TCL session. IsDeviceReady {} Checks if the device is properly connected to the host PC. SelectIOVoltage {IOVoltage} Selects the user interface voltage. SetClockCont {Cont} Defines the serial clock operating mode: continuous clock or hole clock. GetClockCont {} Returns the clock mode currently in use. SetMode {Mode {Display 0}} Defines the SPI operating mode. GetMode {} Returns the SPI operating mode. SetReqClock {Freq} Defines the requested operating clock frequency (in Hz). GetReqClock {} Returns the current requested operating clock frequency (in Hz) GetSynthClock {} Returns the achieved operating clock frequency (in Hz) SetNrOfSlaves {NrSlaves {Display 0}} Defines the number of SPI slaves connected to the device. A maximum of 5 slaves can be connected to the same device. GetNrOfSlaves {} Returns the number of SPI slaves currently defined. SelectSlave {SlaveID {Display 0}} Defines the ID of the slave to select for the next SPI transfer. GetSelectedSlave {} Returns the ID of the slave currently selected for SPI transfers. SetSSEdges {SSDelayStart SSDelayStop {Display 0}} Defines the slave select edge positions. GetSSDelayStart {} Returns the SS start edge position. GetSSDelayStop {} Returns the SS stop edge position. SetSSClockMasking {Enable} Defines the clock masking behaviour with the slave select GetSSClockMasking {{Display 0}} Returns the clock masking mode with the slave select SetLatencyClockMasking {Enable} Defines the clock masking behaviour during SPI3 latency GetLatencyClockMasking {{Display 0}} Returns the clock masking behaviour during SPI3 latency SetSSActiveLevel {Level} Defines the active level of the SS signal(s). GetSSActiveLevel {{Display 0}} Returns the active level of the SS signal(s). SetBitOrder {BitOrder} Defines the bit ordering within each data byte. GetBitOrder {{Display 0}} Returns the bit ordering within each data byte. Plugin4V7V {BitOrder} Enable or disable to 4V to 7V plug-in. WriteConfFile {FileName {Message 1}} Writes the SPI configuration to a file. ReadConfFile {FileName { Message 1}} Reads the SPI configuration from a file. Idle {NrBits {Message 1}} Runs a given number of Idle cycles. ShiftWrAndRd {NrBits pdataout {Message 1}} Performs a simultaneous write and read access to the selected slave (for SPI-4 only) ShiftWrThenRd {NrBitsOut NrBitsIn pdataout Latency WREnHigh {Message 1}} Performs a write access followed by a read access to/from the selected slave (for SPI-3 only). InitBurst {} Initialise a new burst transfer IdleBurst {NrBits {Message 1}} Adds a pause (in number of Idle cycles) to the burst buffer. ShiftWrAndRdBurst {NrBits pdataout {Message 1}} Adds a new simultaneous write and read access (to the selected slave) to the burst buffer. This is available in SPI-4 mode only. Revision Jan /24

10 Procedures ShiftWrThenRdBurst {NrBitsOut NrBitsIn pdataout Latency WREnHigh {Message 1} SendBurst {{Message 0}} GetFirstBurstTransfer {} GetNextBurstTransfer {} GetBurstData {Nr} GetCapturedData {NrBytes} GetLastErr {} GetScriptLength {FileName} ExecuteScript {FileName} Analyse {NrBits {SPI4Mode 1} {SPI3WrLength 0} {SPI3Latency 0} {SPI3RdLength 0} {Message 0}} SetExportFileName {FileName} GetExportFileName {} SetExportFileType {FileType} GetExportFileType {} SetAutoSave {AutoSave} GetAutoSave {{Display 0}} ExportRawDataFile {FileName} ExportRawSPIDataFile {FileName} ExportDecodedSPIDataFile {FileName} SetInternalTrigger {Internal {Display 0}} GetInternalTrigger {} SetEdgeTrigger{Enable {Display 0}} GetEdgeTrigger{{Display 0}} SetCtrlTrigMask {Mask {Display 0}} GetCtrlTrigMask {} SetCtrlTrigPattern {Pattern {Display 0}} GetCtrlTrigPattern {} SetTriggerPos {Sample} GetTriggerPos {} GetOverSampling {} Description Adds a write access followed by a read access to/from the selected slave to the burst buffer. This is available in SPI-3 mode only) Starts the a new burst transfer Selects the first SPI transfer to readback the captured data. Selects the next SPI transfer to readback the captured data. Returns one single data byte from one transfer. Returns a pointer to the full set of captured data in one transfer. Returns the last encountered error code. Returns the loaded script length in number of samples in SPI Master mode. Executes the loaded script in SPI Master mode. Starts the SPI analyser for a given number of bits. Specifies the output file name for the autosave feature in SPI Analyser mode. Returns the name of output file for the autosave feature in SPI Analyser mode. Specifies the output file type for the autosave feature in SPI Analyser mode. Returns the selected file type for the autosave feature in SPI Analyser mode. Enables / disables the autosave feature for the SPI Analyser. Returns the Enable/Disable status of the autosave feature of the SPI Analyser. Exports the analysed data to a file, in raw format. Export the analysed data to a file, in raw SPI format (values sampled at the SPI clock edges). Exports the analysed data to a file, decoded format. Defines the triggering mode (internal or external). Returns the current triggering mode. Selects edge or level trigger. Returns edge or level trigger. Defines the triggering mask to select the control lines to use as trigger inputs. Returns the triggering mask. Defines the pattern to detect on the trigger inputs to generate the trigger event. Returns the triggering pattern. Defines the position of the trigger in the run that is the number of samples before the trigger. Returns the programmed trigger position. Returns the current clock oversampling. 4.2 Procedures Detailed Description This section gives a detailed description of each procedure. Revision Jan /24

11 Terminate {} conditions: None Closes the SPI TCL session. This function unloads from memory the class instance used to interact with the device and hence disconnects the SPI session from the Smart Router. IsDeviceReady {} see also: None 1 if device is ready. 0 if device not ready or not connected. Returns the status of the connection with the device. Using this function is not required to be able to communicate with the device. It is provided to check status if needed. When another function requests an access to the device, the communication status is always automatically checked before starting the transfer. SelectIOVoltage {IOVoltage} parameters IOVoltage: integer value representing the IO voltage, the IO : voltage can be internally generated of user applied. The voltage level is defined in millivolts. This function only takes the following predefined values: 3300, 2500, 1800, 1500 and The nearest value must be selected when the user applies a different external voltage level. For example, set IOVoltage to 2500 when 2.7V is applied. The default value is conditions: SetClockCont {Cont} Cont: valid values: 0 or 1. see also: Select the clock mode, between continuous clock (Cont = 1) and hole clock (Cont = 0). When the clock operates in continuous mode, it is permanently applied on the device output pin. In hole clock mode, the clock pulses are provided only when data is being transferred (write or read). GetClockCont {} see also: None 1 if device is in continuous mode; 0 if the clock is in hole mode. Returns the SPI clock mode currently in use. SetMode {Mode {Display 0}} Mode: Defines the SPI operation mode that is the clock idle level and the edges used to send and capture data bits. Idle Level MOSI MISO Revision Jan /24

12 0 (00) low falling rising 1 (01) low rising falling 2 (10) high rising falling 3 (11) high falling rising Display: optional parameter to display additional information. By default set to 0 (disabled). Defines the clock idle level and clock edges used to sample or generate data bits. When the clock mode is set to non-continuous (hole mode), the level of the clock when no transfer is performed can be programmed to remain high (modes 2/3) or low (modes 0/1). The SPI clock edges used to generate the data out of the master device (MOSI) or to capture data received by the master (MISO) can also be programmed. According to the selected mode, the data are generated and captured on the rising or falling edge of the SPI clock. see also: GetMode {} see also: None Integer value describing the selected mode. Idle Level MOSI MISO 0 (00) low falling rising 1 (01) low rising falling 2 (10) high rising falling 3 (11) high falling rising Returns the SPI synchronisation mode currently in use. SetReqClock {Freq} conditions: see also: Freq: integer value representing the requested frequency to be used to generate the SPI clock signal (in Hz). The value can be set between 800 Hz and (50MHz) An integer error code <0 if operation failed. Defines the requested frequency for the SPI clock. The parameter of this function is only the requested frequency and not the real frequency that will be generated. The output clock frequency of the device can be programmed with a resolution of 4ns (integer division of a 200MHz reference clock). This means that not all frequencies can be exactly generated. The device always generates the closest frequency corresponding to an integer division of 200MHz and immediately below the requested frequency. Example: requested frequency = Hz achieved frequency = Hz GetReqClock{}, GetSynthClock{} GetReqClock {} conditions: None A decimal value Returns the requested frequency for the device operating clock (unit = Hz) Revision Jan /24

13 see also: GetSynthClock{}, SetReqClock{} GetSynthClock {} conditions: see also: None A decimal value Returns the real output clock frequency generated by the device. This frequency is the closest frequency corresponding to an integer division of 200MHz and immediately below the requested frequency. SetReqClock{}, GetReqClock{} SetNrOfSlaves {NrSlaves {Display 0}} NrSlaves: Value defining the number of slaves connected to the Device. This value can be defined between 0 and 5. Default value is 1. Display: optional parameter used to display additional information. By default set to 0 (disabled). The device can control up to 5 slaves. This function defines the number of slaves connected to the master device. It configures the number Slave Select (SS) that must be used to activate the different slave devices. If the value is set to 0, a single slave device can be connected to the device and the SS line is not driven. conditions: see also: GetNrOfSlaves {} none Integer value Returns the current value programmed defining the number of slave devices connected to the device. SelectSlave {SlaveID {Display 0}} SlaveID: Integer value between 1 and 5. By default, ID=1 is defined. Display: optional parameter used to display additional information. By default set to 0 (disabled). none Defines the ID of the slave that must be selected for the following data transfers. Since the maximum number of slaves that can be connected to the device is limited to 5, the ID value must be defined between 1 and 5. GetSelectedSlave {} none Integer value between 1 and 5. Returns the selected slave. SetSSEdges {SSDelayStart SSDelayStop {Display 0}} SSDelayStart: slave select start edge delay. SSDelayStop: slave select stop edge delay. Display: optional parameter used to display additional information. By default set to 0 (disabled). An integer error code <0 if operation failed. Revision Jan /24

14 Defines the delays for the edges of the slave select signal. The rising and falling edges can separately be shifted from 0 to 2 quarters of clock period before and after the conventional start end end edge of the transaction. Shifting the SS edges automatically sets up the proper clock oversampling. Valid values for the parameters are ranging from -2 to 1. For example, SetSSEdges(-2, 1) means: - SS starts with -2/4 (-1/2) x SCLK delay, relative to the first active SCLK edge of the SPI access - SS ends with +1/4 x SCLK delay, relative to the last active SCLK edge of the SPI access. Please note: the following rules apply for the max. SCLK frequency: Delay on SS (START or STOP) Max. SCLK frequency 0 50 MHz ½ SCLK 25 MHz ¼ SCLK 12.5 MHz GetSSDelayStart {} none Integer value between -2 and 1. Returns the slave select start edge position as defined with the function SetSSEdges GetSSDelayStop {} none Integer value between -2 and 1. Returns the slave select stop edge position as defined with the function SetSSEdges SetSSActiveLevel {Level} Level: valid values: 0 or 1. 0 for active low ; 1 for active high. Defines the SS signal(s) active level (high or low). GetSSActiveLevel {{Display 0}} Display: optional parameter used to display additional information. By default set to 0 (disabled). 0 or 1. 0 for active low ; 1 for active high. Returns the SS signal(s) line active level. SetSSClockMasking {Enable} Enable: valid values: 1 enables the masking of the clock while the slave select is inactive, 0 disables this feature. Defines the clock masking behaviour with the slave select. Revision Jan /24

15 GetSSClockMasking {{Display 0}} Display: optional parameter used to display additional information. By default set to 0 (disabled). 0 or 1. 1 for clock masking with slave select; 0 otherwise. Returns the clock masking mode with the slave select. SetLatencyClockMasking {Enable} Enable: valid values: 1 enables the masking of the clock during the SPI3 latency, i.e. while the SPI3 master switched from write to read; 0 disables this feature. Defines the clock masking behaviour during SPI3 latency. GetLatencyClockMasking {{Display 0}} Display: optional parameter used to display additional information. By default set to 0 (disabled). 0 or 1. 1 for clock masking during SPI3 latency; 0 otherwise. Returns the clock masking behaviour during SPI3 latency. SetBitOrder {BitOrder} BitOrder: sets MS bit / LS bit first none Defines the bit ordering within each data byte 0 LS bit first: each byte is sent/read from LSb to MSb 1 MS bit first: each byte is sent/read from MSb down to LSb Note that the least significant byte of the buffer is always sent first. GetBitOrder {{Display 0}} Display: optional parameter used to display additional information. By default set to 0 (disabled). Value representing the bit order within each data byte. Defines the bit ordering within the data bytes. 0 LS bit first 1 MS bit first Note that the least significant byte of the buffer is always sent first. Plugin4V7V {Enable} Enable: enables or disables the 4V-7V plug-in none WriteConfFile {FileName {Message 1}} FileName: Output file name, including path. Message: Flag controlling the generation of dialog box to report error messages. 1 dialog box enabled 0 dialog box disabled When dialog box are disabled, the error is only reported using the return code. none Revision Jan /24

16 Writes the current SPI configuration to a file. Refer to [2] for a description of the configuration file format. ReadConfFile {FileName {Message 1}} FileName: Input file name, including path. Message: Flag controlling the generation of dialog box to report error messages. 1 dialog box enabled 0 dialog box disabled When dialog box are disabled, the error is only reported using the return code. none Reads a configuration from a file. Refer to [2] for a description of the configuration file format. Idle {NrBits {Message 1}} NrBits: Number of bits (or SPI clock cycles) to run. Message: Flag controlling the generation of dialog box to report error messages. 1 dialog box enabled 0 dialog box disabled When dialog box are disabled, the error is only reported using the return code. Integer: Error code: 0 if successful; another value if failed (SPI Master) Holds the SPI interface lines in their default level during a given number of SPI clock cycles. ShiftWrAndRd {NrBits pdataout {Message 1}} NrBits: Integer value representing the total number of bits to be transferred to/from the slave device. This value must be defined between 1 and a max value described in Table 2. ( bits is the absolute maximum). pdataout: Value in hex (0x) with the data to send out. Message: Flag controlling the generation of dialog box to report error messages. 1 dialog box enabled 0 dialog box disabled When dialog box are disabled, the error is only reported using the return code. An integer error code. 0 if successful. Performs a simultaneous write and read access to the slave device. This function can only be used for a 4-wire SPI configuration. Each time a bit is sent out, a bit is captured. If more bits must be read than written, then the output data buffer must be padded with 0 to contain the correct number of bits. The read value is stored in the TCL global variable ShiftDataIn. SPI 4 accesses SPI 3 accesses SS start delay SS end delay ShiftWrAndRd max. access length ShiftWrThenRd Max. WR ShiftWrThenRd Max. Latency ShiftWrThenRd Max. Rd length length length (don t care) -1/4 SCLK bits bits bits Revision Jan /24

17 (don t care) +1/4 SCLK bits bits bits -1/2 SCLK -1/2 SCLK bits bits bits -1/4 SCLK (don t care) bits bits 400 bits bits +1/4 SCLK (don t care) bits bits bits no delay bits bits bits Table 2 : Access length according to access type and SS edges positioning. Refer to function SetSSEdges for more information about how to set the SS start and end delays. Positioning SS at ½ or ¼ of SCLK automatically switches an oversampling mode in the device, which limits the maximum access length of each type of access. ShiftWrThenRd {NrBitsOut NrBitsIn pdataout Latency WREnHigh {Message 1}} NrBitsOut: Integer value representing the number of bits to be written to the slave device. This value must be defined between 1 and a max. value described in Table 2. NrBitsIn: Integer value representing the number of bits to be read from the slave device. This value must be defined between 0 and a max. value described in Table 2. pdataout: Value in hex (0x) with the data to send out. Latency: Integer value defining the number of clock cycles to insert between the write and read access. The value must be defined between 0 and 400. WrEnHigh: Boolean flag defining the polarity of the write enable signal. 1 active high write enable 0 active low write enable Message: Boolean flag controlling the generation of dialog box to report error messages. 1 dialog box enabled 0 dialog box disabled When dialog box are disabled, the error is only reported using the return code. An integer error code. 0 if successful. Performs a write access followed by a read access to the slave device. This function can only be used for a 3-wire SPI configuration. A first write access is performed to the selected slave device. The length of the access is defined by NrBitsOut. Then an idle period of programmable length (Latency) is waited before starting the read access. This idle period is used to give time to reverse the data signal direction. The latency can be programmed to 0, but it is recommended to program it at least to 1 to avoid shorts/conflict on the data line due to the time needed by the different devices to reverse the direction. When the idle period is completed, a read access is started. NrBitsIn bits are captured. The read value is stored in the TCL global variable ShiftDataIn. InitBurst {} none Initialises the system for a new SPI burst transfer. Data read during a previous burst and still available in memory is discarded. Revision Jan /24

18 IdleBurst {NrBits {Message 1}} NrBits: Number of bits (or SPI clock cycles) to run. Message: Flag controlling the generation of dialog box to report error messages. 1 dialog box enabled 0 dialog box disabled When dialog box are disabled, the error is only reported using the return code. Integer: Error code: 0 if successful; another value if failed (SPI Master) Holds the SPI interface lines in their default level during a given number of SPI clock cycles. IdleBurst is used with the burst transfer. A burst transfer executes in 2 steps. First, the burst commands are stacked into memory; second, when calling the SendBurst function, the stored burst commands are executed one by one. ShiftWrAndRdBurst {NrBits pdataout {Message 1}} NrBits: Integer value representing the total number of bits to be transferred to/from the slave device. This value must be defined between 1 and a max value described in Table 2. ( bits is the absolute maximum). pdataout: Value in hex (0x) with the data to send out. Message: Flag controlling the generation of dialog box to report error messages. 1 dialog box enabled 0 dialog box disabled When dialog box are disabled, the error is only reported using the return code. An integer error code. 0 if successful. Adds a new simultaneous write and read access (to the slave device) to the burst buffer. The burst transfer is started by calling the SendBurst function. This function can only be used for a 4-wire SPI configuration. Each time a bit is sent out, a bit is captured. If more bits must be read than written, then the output data buffer must be padded with 0 to contain the correct number of bits. Revision Jan /24

19 ShiftWrThenRdBurst {NrBitsOut NrBitsIn pdataout Latency WREnHigh {Message 1}} NrBitsOut: Integer value representing the number of bits to be written to the slave device. This value must be defined between 1 and a max. value described in Table 2. NrBitsIn: Integer value representing the number of bits to be read from the slave device. This value must be defined between 1 and a max. value described in Table 2. pdataout: Value in hex (0x) with the data to send out. Latency: Integer value defining the number of clock cycles to insert between the write and read access. The value must be defined between 0 and 400. WrEnHigh: Boolean flag defining the polarity of the write enable signal. 1 active high write enable 0 active low write enable Message: Boolean flag controlling the generation of dialog box to report error messages. 1 dialog box enabled 0 dialog box disabled When dialog box are disabled, the error is only reported using the return code. An integer error code. 0 if successful. Adds a new write access followed by a read access (to the slave device) to the burst buffer. The burst transfer is started by calling the SendBurst function. This function can only be used for a 3-wire SPI configuration. A first write access is performed to the selected slave device. The length of the access is defined by NrBitsOut. Then an idle period of programmable length (Latency) is waited before starting the read access. This idle period is used to give time to reverse the data signal direction. The latency can be programmed to 0, but it is recommended to program it at least to 1 to avoid shorts/conflict on the data line due to the time needed by the different devices to reverse the direction. When the idle period is completed, a read access is started. NrBitsIn bits are captured. Note that the WrEnHigh and the Latency must be the same for all transfers in one burst. SendBurst {} none Executes the SPI transfers defined by successive calls to the ShiftWrAndRdBurst and ShiftWrThenRdBurst function. GetFirstBurstTransfer {} none An integer error code: < 0 if operation failed; if successful. After the execution of a burst transfer, this command requests the selection of the first SPI transfer to prepare the readback of the captured data. To actually read the readback data, please refer to GetBurstData and GetCapturedData; to select the following burst transfer, please refer to the GetNextBurstTransfer function. Revision Jan /24

20 GetNextBurstTransfer {} none An integer error code: < 0 if operation failed; if successful. After the execution of a burst transfer, this command requests the selection of the next SPI transfer to prepare the readback of the captured data. To actually read the readback data, please refer to GetBurstData and GetCapturedData; to select the first burst transfer, please refer to the GetFirstBurstTransfer function. GetBurstData {Nr} Nr : integer used to select the byte index within the selected transfer. For instance, if one single transfer is to return 5 bytes of data, Nr can take values from 0 to 4. An integer error code: < 0 if operation failed; if successful. Returns one single data byte from the transfer selected with GetFirstBurstTransfer or GetNextBurstTransfer commands. The requested data is stored in the global variable ShiftDataIn. Please also refer to GetCapturedData GetCapturedData {NrBytes} NrBytes : integer used to specify the total number of bytes to collect from the selected transfer. An integer error code: < 0 if operation failed; if successful. Returns the specified number of bytes from the transfer selected with GetFirstBurstTransfer or GetNextBurstTransfer commands. GetLastErr {} none Returns the last error code returned by the device. GetScriptLength {FileName} FileName: String path and file name of the script. An integer value representing the script length in number of SPI accesses. This function analyses the script file given as input parameter and returns its length in number of lines. ExecuteScript {FileName} FileName: String path and file name of the script. Integer : 0 if execution successful; other value if execution failed. Starts the execution of the script given as input parameter in SPI Master mode. Revision Jan /24

21 Analyse {NrBits {SPI4Mode 1} {SPI3WrLength 0} {SPI3Latency 0} {SPI3RdLength 0} {Message 0}} NrBits: unsigned integer specifying the number of samples to analyse. SPI4Mode: boolean defining the SPI interface type (SPI4 or SPI3) SPI3WrLength: in SPI3 mode, length of the write phase in clock cycles SPI3Latency: in SPI3 mode, length of the write-to-read latency in clock cycles. SPI3RdLength: in SPI3 mode, length of the read phase in clock cycles. Message: boolean value enabling / disabling the function popup messages; 1 to enable; 0 to disable. Integer : 0 if execution successful; other value if execution failed. Starts the sampling and the analysis of the specified number of samples from a SPI interface. Note that the analysis is done by oversampling the SPI interface. Hence, the NrBits parameters specifies a number of samples taken and not the number of SPI bits sampled. Example: assume one wants so sample a 1MHz SPI bus during 1ms with on oversampling of 10, this would mean NrBits must be equal to SetExportFileName {FileName} FileName : String path and file name of the export file Specifies the name of the export file used with the autosave feature. GetExportFileName {Display 0} String path and file name of the export file. Returns the name of the export file used with the autosave feature. SetExportFileType { FileType } FileType: unsigned integer representing the output file type: 0 : Raw data file 1 : SPI raw data file 2 : Decoded data file Specifies the type of the export file used with the autosave feature. The SPI Analyser proceeds by oversampling the data from the SPI port. It can present the data in 3 formats: 0 : Raw data file: all the samples are given out. 1 : SPI raw data file : the analyser the SPI port signals sampled at the chosen SPI clock edge. 2 : Decoded data file : the SPI transaction are extracted from the bitstream (refer to [2] for a description of the corresponding syntax). GetExportFileType {} none Integer representing the file type: 0 : Raw data file 1 : SPI raw data file 2 : Decoded data file Returns the file type programmed with SetExportFileType() function for Revision Jan /24

22 the SPI Analyser autosave feature.. SetAutoSave {AutoSave} AutoSave: boolean 1 to enable; 0 to disable. Enables / disables the SPI Analyser autosave. GetAutoSave {{Display 0}} Display: optional parameter used to display additional information. By default set to 0 (disabled). 0 or 1. 1 for auto-saving; 0 otherwise. Returns the enable / disable status of the SPI Analyser autosave feature: 1 if enabled; 0 if disabled. ExportRawDataFile {FileName} FileName : output export path and file name. An integer error code: 0 if export successful; other value if export failed. Exports the SPI analysed data to an output file, using the raw data format (please refer to [2] for a description of the SPI Analyser formats). ExportRawSPIDataFile {FileName} FileName : output export path and file name. An integer error code: 0 if export successful; other value if export failed. Exports the SPI analysed data to an output file, using the raw SPI data format (please refer to [2] for a description of the SPI Analyser formats). ExportDecodedSPIDataFile {FileName} FileName : output export path and file name. An integer error code: 0 if export successful; other value if export failed. Exports the SPI analysed data to an output file, using the decoded SPI data format (please refer to [2] for a description of the SPI Analyser formats). SetInternalTrigger {Internal {Display 0}} Internal: boolean selecting the trigger type 1 for internal trigger; 0 for external trigger. Display: optional parameter used to display additional information. By default set to 0 (disabled). To trigger the SPI Analyser, 2 types of trigger can be selected: - an internal trigger the SPI Analyser starts immediately when the user runs the Analyse() command; - an external trigger, defined onto the device 6 control lines. GetInternalTrigger {} 1 for internal trigger; 0 for external trigger. Returns the trigger type previously programmed with the SetInternalTrigger{} function. SetEdgeTrigger {Enable {Display 0}} Enable: boolean boolean selecting edge or level trigger 1 for Revision Jan /24

23 edge trigger; 0 for level trigger. Display: optional parameter used to display additional information. By default set to 0 (disabled). To Selects edge or level trigger. GetEdgeTrigger {{Display 0}} Display : optional parameter used to display additional information. By default set to 0 (disabled).. 1 for edge trigger; 0 for level trigger. Returns edge or level trigger. SetCtrlTrigMask {Mask {Display 0}} Mask: Integer. This range of the mask depends on the operating mode: Analyser mode : value represents a 6 bit mask and ranges from 0x01 to 0x3F. Master mode : value represents a 4 bit mask and ranges from 0x02 to 0x1E; bit 0 is used for the write enable signal and bit 5 is used for the clock. Display:optional parameter used to display additional information. By default set to 0 (enabled). When the external triggering mode is used, the trigger mask selects the control lines to be used as trigger inputs. When a mask bit is set to 0, the corresponding control line is masked for triggering. The mask is given as a pointer to a short value equivalent to the binary value of the mask (example: mask = (Binary) *pmask points to a short = 24). GetCtrlTrigMask {} none. Returns the mask applied on the control lines to detect the external trigger. SetCtrlTrigPattern {Pattern {Display 0}} Pattern: Integer. This range of the pattern depends on the operating mode: Analyser mode : value represents a 6 bit mask and ranges from 0x01 to 0x3F. Master mode : value represents a 4 bit mask and ranges from 0x02 to 0x1E; bit 0 is used for the write enable signal and bit 5 is used for the clock Display:optional parameter used to display additional information. By default set to 0 (disabled). Defines the pattern to detect on the trigger inputs to generate the trigger event. The pattern is given as a pointer to a short value equivalent to the binary value of the pattern (example: pattern = (Binary) *ppattern points to a short = 24). Revision Jan /24

24 GetCtrlTrigPattern {} none. Returns the pattern applied on the control lines to generate a trigger event and start applying data samples on the device system connector. SetTriggerPos {Sample} Sample: integer value representing the index of the sample in the run where the trigger should be positioned. An integer error code: 0 is successful; another value if unsuccessful. Use this function to position the trigger after a given number of samples in the total run. Once the sampling run is over, the corresponding number of samples before the trigger is displayed, together with the rest of the run after the trigger. GetTriggerPos {} none. A integer representing the trigger position. Returns the trigger position previously programmed. The trigger position is defined with the sample index at which it is positioned. GetOverSampling {} none. An integer value equal to 1, 2 or 4. According to the position of the SPI Master SS edges, the device automatically selects the adequate oversampling of its internal clock with respects to the SPI clock. This function returns the selected oversampling. Revision Jan /24