FX3Connection Class

Class Constructor. Loads SPI settings and default values for the interface, and starts a background thread to manage programming newly connected boards with the ADI bootloader.

Property which returns the active FX3 board. Returns nothing if there is not a board connected.

Property which returns the serial number of the active FX3 board.

Property which returns a list of the serial numbers of all FX3 boards running the ADI bootloader

Property to get or set the bit bang SPI configuration. Can select pins, timings, etc

Set/get the blink USB bootloader firmware .img file used for multi-board identification

Checks if a streaming frame is available, or will be available soon in thread safe queue. If there is no data in the queue and the streaming thread is not currently running, it will return false.

Get or set the burst word length, in bytes. Is the total count of bytes transfered, including trigger

Switches burstMode on and off. Set burstMode to the number of burst read registers.

Data to transmit on the MOSI line during a burst read operation. This value is over written if you set the trigger reg, since trigger reg is given priority.

Property which returns a list of the serial numbers of all FX3 boards currently in use, running the application firmware.

Property to get or set the FX3 SPI controller chip select setting. Should be left on hardware control, changing modes will likely cause unexpected behavior. Reqcode: B2 Value: Desired setting (as SpiChipselectControl ) Index: 4 Length: 4 Data: None

The number of SPI clock cycles after the transaction ends that chip select is toggled to idle. Reqcode: B2 Value: Desired Setting (as SpiLagLeadTime ) Index: 6 Length: 4 Data: None

The number of SPI clock cycles before the SPI transaction that chip select is toggled to active. Reqcode: B2 Value: Desired Setting (as SpiLagLeadTime ) Index: 5 Length: 4 Data: None

Property to get or set the FX3 SPI chip select polarity (True - Active High, False - Active Low) Reqcode: B2 Value: Polarity (0 active low, 1 active high) Index: 3 Length: 4 Data: None

Property to get or set the FX3 SPI controller chip select phase Reqcode: B2 Value: Polarity (0 active low, 1 active high) Index: 2 Length: 4 Data: None

Property to get or set the FX3 SPI controller clock polarity setting (True - Idles High, False - Idles Low) Reqcode: B2 Value: Polarity (0 active low, 1 active high) 'Index: 1 Length: 4 Data: None

Gets or sets the index of the first burst data word used in CRC calculations.

Gets or sets the index of the last burst data word used in CRC calculations.

Gets or sets the index of the word that contains the CRC result.

Read-only property to get the DIO1 pin

Read-only property to get the DIO2 pin

Read-only property to get the DIO3 pin

Read-only property to get the DIO4 pin

If the data ready is used for register reads

This property is used to get or set the data ready pin. Is tied to the ReadyPin property

The Data Ready polarity for streaming mode (index 11)

Get or set the DUT supply mode on the FX3. Available options are regulated 3.3V, USB 5V, and off. This feature is only available on the ADI in-house iSensor FX3 eval platform, not the platform based on the Cypress Explorer kit. If a Cypress Explorer kit is connected, the setter for this property will be disabled.

The path to the firmware .img file. Needs to be set before the FX3 can be programmed

Path to the programmer firmware which is loaded in RAM to allow flashing the EEPROM with the bootloader.

Read-only property to get the FX3_GPIO1 pin. This pin does not map to the standard iSensor breakout, and should be used for other general purpose interfacing.

Read-only property to get the FX3_GPIO2 pin. This pin does not map to the standard iSensor breakout, and should be used for other general purpose interfacing.

Read-only property to get the FX3_GPIO3 pin. This pin does not map to the standard iSensor breakout, and should be used for other general purpose interfacing.

Read-only property to get the FX3_GPIO4 pin. This pin does not map to the standard iSensor breakout, and should be used for other general purpose interfacing. This pin shares a complex GPIO block with DIO1. If DIO1 is being used as a clock source, via the StartPWM function, then this pin cannot be used as a clock source.

Read-only property to get loop back pin 1. This pin (CTL8) is wired directly to loop back pin 2 (CTL9) on the iSensor FX3 Board, Revision C or newer. These loop back pins allow for fixed transaction timing on "asynchronous" SPI/I2C reads. One of the loop back pins can be configured as a PWM output using the "StartPWM" API, and the other loop back pin can be set as the DrPin, allowing the FX3 to trigger itself at a known rate.

Read-only property to get loop back pin 2. This pin (CTL9) is wired directly to loop back pin 1 (CTL8) on the iSensor FX3 Board, Revision C or newer. These loop back pins allow for fixed transaction timing on "asynchronous" SPI/I2C reads. One of the loop back pins can be configured as a PWM output using the "StartPWM" API, and the other loop back pin can be set as the DrPin, allowing the FX3 to trigger itself at a known rate.

Checks if there is a Cypress FX3 USB device connected to the system

Checks the boot status of the FX3 board by sending a vendor request

Property which reads the firmware version from the FX3

This property returns a class containing some useful information about the current FX3 Dll. Some of the information is available as a attribute of the DLL, while others (build date/time and git revision) are generated at compile time using a pre-build batch file script.

Read-only property to get the number of buffers read in from the DUT in buffered streaming mode

Read-only property to get the serial number of the active FX3 board

Get/Set the FX3 I2C bit rate. Valid range 100KHz - 1MHz. Defaults to 100KHz

Get/Set the FX3 I2C retry count. This is the number of times the FX3 will retry a read/write when a NAK is received from the slave device being addressed.

The FX3 SPI Controller LSB setting. The controller flips the bits depending on this setting. Reqcode: B2 Value: Polarity (0 MSB first, 1 LSB first) Index: 7 Length: 4 Data: None

Read-only property to get the number of bad frames purged with a call to PurgeBadFrameData. Frames are purged when the CRC appended to the end of the frame does not match the expected CRC.

Property to get the number of frame skips in an ADcmXL real time stream

The DUT type connected to the board. Reqcode: B2 Value: Part type to set Index: 10 Length: 4 Data: None

Gets and sets the sync pin exit configuration for exiting real-time stream mode on ADcmXL DUT's.

Gets and sets the sync pin start configuration for starting real-time stream mode on ADcmXL DUT's.

Property to get or set the DUT data ready pin.

Read-only property to get the reset pin

Property to get or set the FX3 SPI clock frequency setting. Reqcode: B2 Value: Don't Care Index: 0 Length: 4 Data: Clock Frequency to be set

Property to get the device family type the FX3 was initialized for. Setting this property restores all SPI settings to the default for the selected device family.

Property to get/set the number of microseconds between words Reqcode: B2 Value: Stall time in microseconds (as int16) Index: 9 Length: 4 Data: None

Sets the timeout for the Bulk Endpoint used in real time streaming modes.

Property to choose if the readback from the 16 bit trigger word at the start of each burst is discarded or not

Read only property to get the timer tick scale factor used for converting ticks to ms.

Gets or sets register that is used to trigger burst operation.

Enable or disable the FX3 firmware watchdog.

Set the FX3 firmware watchdog timeout period (in seconds). If the watchdog is triggered the FX3 will reset.

Gets or sets the number of 16 bit words that are read during the burst. Does not include trigger, real transfer will be 2 bytes larger.

The FX3 SPI controller word length. Default is 8 (1 byte per word) Reqcode: B2 Value: Word length (as int8) Index: 8 Length: 4 Data: None

Read a standard iSensors 16-bit register using a bitbang SPI connection

Perform a bit banged SPI transfer, using the config set in BitBangSpiConfig.

Write a byte to an iSensor register using a bitbang SPI connection

BOOTLOADER FW: Blink the on-board LED

BOOTLOADER FW: Turn off the LED

BOOTLOADER FW: Turn on the LED

Cancel a any running stream

Takes interface out of burst mode by setting BurstMode to zero.

Clear the error log stored in flash

Attempts to program the selected FX3 board with the application firmware. The FX3 board should be programmed with the ADI bootloader.

This function sends a reset command to the specified FX3 board, or does nothing if no board is connected

Overload of Disconnect which lets you specify the FX3 serial number to disconnect. Returns a boolean indicating if the board was disconnected.

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Function which checks if the FX3 is connected and programmed

Gets one frame from the thread safe queue. Waits to return until a frame is available if there is a stream running. If there is not a stream running, and there is no data in the queue this call returns "Nothing".

This function returns a single buffered stream packet. Needed for IBufferedStreamProducer

Gets the current error log from FX3 flash memory

Get the number of errors logged to the FX3 flash memory

Serves as the default hash function.

Get I2C buffer from I2C read stream

Allows the user to retrieve a set of information about the current pin PWM configuration.

This function does the same thing as GetBufferedStreamDataPacket()

This function reads the current value from the 10MHz timer running on the FX3

Gets the Type of the current instance.

Read bytes from an I2C slave device attached to the FX3.

Write bytes to an I2C slave device attached to the FX3

ISpi32 StopStream implementation. Calls generic version.

This function checks to see if the selected pin has already been configured to act as a PWM output pin.

Overload of measure busy pulse which triggers the DUT event using a SPI write instead of a pin drive.

This function triggers a DUT action using a pulse drive, and then measures the following pulse width on a separate busy line. The pulse time on the busy pin is measured using a 10MHz timer with approx. 0.1us accuracy.

This function measures the time delay between toggling a trigger pin, and a state change on the busy pin. This can be used to measure the propagation delay between a sync edge and data ready being de-asserted.

Measures the frequency of an input signal to the selected pin.

Creates a shallow copy of the current Object.

This function drives a pin to the specified level for a given time interval in ms

This function waits for a pin to reach a specified level

This function checks the CRC of each real time streaming frame stored in the Stream Data Queue, and purges the bad ones. This operation is only valid for an ADcmXL series DUT.

Reads the measured DR value

Read data from the FX3 non-volatile memory

Reads the value of a GPIO pin on the FX3

Reads a list of FX3 GPIO pins. This function calls the overload which takes an IEnumerable

Reads a list of FX3 GPIO pins

Reads an array of 16 bit register values.

ReadRegArray overload which includes register writes. Breaks the call into multiple calls of readRegByte and writeRegByte

Overload of ReadRegArray which builds a new IEnumerable of addr and call the overload which takes an enumerable of addr

This is the most generic array register function. All other array read/write functions call down to this one.

This is the most general ReadRegByte. Other implementations are based on this.

Reads a single 16 bit register on the DUT

Not implemented

Drives the Reset pin low for 10ms, sleeps for 100ms, and then blocks until the ReadyPin is high (500ms timeout)

Looks for and resets boards in application mode. Should only be called at program start, after InitBoardList() Note: Should not be used if running multiple instances of the GUI.

Resets the hardware SPI pins to their default operating mode. Can be used to recover the SPI functionality after a bit-bang SPI transaction over the hardware SPI pins without having to reboot the FX3.

Sets the SCLK frequency for a bit bang SPI connection.

Set the SCLK frequency for a bit banged SPI connection. Overloaded to allow for a UInt

Set the bit bang SPI stall time. Driven by a clock with resolution of 49.3ns

Sets the value of a FX3 GPIO pin. This value will persist until the pin is set to a different value, or read from

Set the FX3 GPIO input stage pull up or pull down resistor setting. All FX3 GPIOs have a software configurable pull up / pull down resistor (10KOhm).

Puts interface into burst mode by setting burstMode to match word count.

This function is not currently implemented. Calling it will throw a NotImplementedException.

Starts a buffered stream operation. This is usually called from the TextFileStreamManager. DUTType must be set before executing.

Starts a buffered stream operation. The registers listed in addr are read numCaptures times per register buffer. This process is repeated numBuffers times.

Function to start a burst read using the BurstStreamManager

Starts a generic data stream. This allows you to read/write a set of registers on the DUT, triggering off the data ready if needed. The data read is placed in the thread-safe queue and can be retrieved with a call to GetBuffer. Each "buffer" is the result of reading the addr list of registers numCaptures times. For example, if addr is set to [0, 2, 4] and numCaptures is set to 10, each buffer will contain the 30 register values. The total number of register reads performed is numCaptures * numBuffers

Start an asynchronous I2C read stream. This stream runs on the stream thread and places all data in a thread safe queue. The data can be retrieved using GetI2CBuffer()

This function configures the selected pin to drive a pulse width modulated output.

This function starts real time streaming on the ADcmXLx021 (interface and FX3). Specifying pin exit is optional and must be 0 (disabled) or 1 (enabled)

Starts a buffered stream for only a single buffer. This is equivalent to StartBufferedStream(addr, numCaptures, 1, CurrentTimeout, Nothing)

This function call disables the PWM output from the FX3 and returns the pin to a tri-stated mode.

This function stops real time streaming on the ADcmXLx021 (stream thread in FX3 API and FX3 firmware)

Stops the currently running data stream, if any.

Returns a string that represents the current object.

This function performs a single bi-directional 32 bit SPI transaction. If DrActive is set to false the transfer is performed asynchronously. If DrActive is set to true, the transfer should wait until a data ready condition (determined by DrPin and DrPolarity) is true.

This function performs an array bi-directional SPI transfer. WriteData.Count() total SPI transfers are performed. If DrActive is set to true, the transfer should wait until a data ready condition (determined by DrPin and DrPolarity) is true, and then perform all SPI transfers. If DrActive is false it is performed asynchronously.

This function performs an array bi-directional SPI transfer. This overload transfers all the data in WriteData numCaptures times. The total number of SPI words transfered is WriteData.Count() * numCaptures. If DrActive is set to true, the transfer should wait until a data ready condition (determined by DrPin and DrPolarity) is true, and then perform all SPI transfers. If DrActive is false it is performed asynchronously.

This function performs an array bi-directional SPI transfer. If DrActive is set to true, this overload transfers all the data in WriteData numCaptures times per data ready condition being met. It captures data from numBuffers data ready signals. If DrActive is set to false, all the transfers are performed asynchronously. The total number of SPI transfers is WriteData.Count()*numCaptures*numBuffers. The following pseduo-code snippet would perform 400 total SPI transfers, across 100 data ready conditions. MOSI = {0x1234, 0x5678} myISpi32.DrActive = True MISO = myISpi32.TransferArray(MOSI, 2, 100) During the transfers, the SPI bus would look like the following: MOSI: ---(0x1234)---(0x5678)---(0x1234)---(0x5678)-----------------(0x1234)---(0x5678)---(0x1234)---(0x5678)--...-----(0x1234)-----(0x5678)-----(0x1234)-----(0x5678)-- MISO:----MISO(0)----MISO(1)----MISO(2)----MISO(3)------------------MISO(4)----MISO(5)----MISO(6)----MISO(7)---...-----MISO(196)----MISO(197)----MISO(198)----MISO(199)- DR: ___|¯¯¯|_____________________________________________________|¯¯¯|______________________________________..._____|¯¯¯|____________________________________________

Blink user LED using timer hardware (not available on Cypress Explorer FX3 board)

Turn off user LED (not available on Cypress Explorer FX3 board)

Turn on user LED (not available on Cypress Explorer FX3 board)

This function is used to wait for an FX3 to be programmed with the ADI bootloader. In general, the programming model would go as follows, to connect and program the first board attached: Dim myFX3 as FX3Connection = New FX3Connection(firmwarepath, bootloaderpath, devicetype) If Not myFX3.WaitForBoard(10) Then Msgbox("No boards found") Exit Sub End If myFX3.Connect(myFX3.AvailableFX3s(0))

Overload of WaitForStreamCompletion which blocks indefinitely until a stream completion event is seen.

Blocks until the streaming endpoint mutex can be acquired. Allows a user to synchronize external application the completion of a stream. Returns false if there is not a stream running, or if the timeout is reached without the stream mutex being acquired.

Array transfer which performs an initial SPI transmit (MOSI only, no read back) then starts a read stream. This is useful if you need to issue a write to the DUT, then immediately start reading back data, without the USB transfer overhead of approx 150us

This function writes a single register byte, given as an Address / Data pair

This function writes an enumerable list of data to the DUT as AddrDataPairs

Overload of WriteRegByte which allows for multiple registers to be specified to write to, as an IEnumerable list of register addresses.

This is the most general WriteRegByte, which the others are based on

This function is not currently implemented. Calling it will throw a NotImplementedException.

This event is raised when the disconnect event for a board has finished, and it is reprogrammed with the ADI bootloader. This event only is triggered for boards which were explicitly disconnected (boards which were physically reset will not trigger this event).

This event is raised when there is a new buffer available from a buffered stream

This event is raised when a stream is finished

This event is raised when the active board is disconnected unexpectedly (IE unplugged)