A B C D E F G H I J L M N P R S T U V W X Z

A

allocateByteBuffer(byte[]) - Static method in class ztex.Ztex1

Utility function that creates a ByteBuffer from byte array.

allocateByteBuffer(byte[], int, int) - Static method in class ztex.Ztex1

Utility function that creates a ByteBuffer from byte array.

AlreadyConfiguredException - Exception in ztex

Thrown if the FPGA is already configured.

AlreadyConfiguredException(HasName, String) - Constructor for exception ztex.AlreadyConfiguredException

Constructs an instance from the given input string.

AlreadyConfiguredException(HasName) - Constructor for exception ztex.AlreadyConfiguredException

Constructs an instance using a standard message.

B

BitstreamReadException - Exception in ztex

Signals that an error occurred while attempting to read a bitstream.

BitstreamReadException(String) - Constructor for exception ztex.BitstreamReadException

Constructs an instance from the given error message.

BitstreamReadException() - Constructor for exception ztex.BitstreamReadException

Constructs an instance using a standard message.

BitstreamUploadException - Exception in ztex

Signals that an error occurred while attempting to upload the bitstream.

BitstreamUploadException(HasName, String) - Constructor for exception ztex.BitstreamUploadException

Constructs an instance from the given error message.

BitstreamUploadException(HasName) - Constructor for exception ztex.BitstreamUploadException

Constructs an instance using a standard message.

boardNames - Static variable in class ztex.ConfigData

Kinds of FPGA Boards.

bufSize() - Method in class ztex.ZtexUsbReader

Return the buffer size.

bufSize() - Method in class ztex.ZtexUsbWriter

Return the buffer size.

bulkRead(int, ByteBuffer, long) - Method in class ztex.Ztex1

Wrapper method for LibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).

bulkRead(int, byte[], int, long) - Method in class ztex.Ztex1

Wrapper method for LibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).

bulkWrite(int, ByteBuffer, long) - Method in class ztex.Ztex1

Wrapper method for ibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).

bulkWrite(int, byte[], int, long) - Method in class ztex.Ztex1

Wrapper method for LibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).

byteArrayString(byte[]) - Static method in class ztex.ZtexDevice1

Produces a nice string representation of an array of bytes.

byteCount() - Method in class ztex.ZtexUsbReader

Return the number of bytes read since last ZtexUsbReader.start(long).

byteCount() - Method in class ztex.ZtexUsbWriter

Return the number of bytes transmitted.

C

cancel() - Method in class ztex.ZtexUsbReader

Cancels all pending transfers, also see ZtexUsbReader.cancelWait(int),

cancel() - Method in class ztex.ZtexUsbWriter

Cancels all pending transfers, also see cancelWait(int).

cancelWait(int) - Method in class ztex.ZtexUsbReader

Cancels all pending transfers and waits until transfers are canceled.

cancelWait(int) - Method in class ztex.ZtexUsbWriter

Cancels all pending transfers and waits until transfers are canceled.

CAPABILITY_DEBUG - Static variable in class ztex.Ztex1v1

Capability index for DEBUG helper support.

CAPABILITY_DEBUG2 - Static variable in class ztex.Ztex1v1

Capability index for debug helper 2

CAPABILITY_DEFAULT - Static variable in class ztex.Ztex1v1

Capability index for default firmware interface

CAPABILITY_EEPROM - Static variable in class ztex.Ztex1v1

Capability index for EEPROM support.

CAPABILITY_FLASH - Static variable in class ztex.Ztex1v1

Capability index for FLASH memory support.

CAPABILITY_FLASH2 - Static variable in class ztex.Ztex1v1

Capability index for 2nd FLASH memory support.

CAPABILITY_FPGA - Static variable in class ztex.Ztex1v1

Capability index for FPGA configuration support.

CAPABILITY_FX3 - Static variable in class ztex.Ztex1v1

Capability index for FX3 firmware

CAPABILITY_HS_FPGA - Static variable in class ztex.Ztex1v1

Capability index for AVR XMEGA support.

CAPABILITY_MAC_EEPROM - Static variable in class ztex.Ztex1v1

Capability index for AVR XMEGA support.

CAPABILITY_MULTI_FPGA - Static variable in class ztex.Ztex1v1

Capability index for multi FPGA support

CAPABILITY_TEMP_SENSOR - Static variable in class ztex.Ztex1v1

Capability index for Temperature sensor support

CAPABILITY_XMEGA - Static variable in class ztex.Ztex1v1

Capability index for AVR XMEGA support.

CapabilityException - Exception in ztex

Thrown is a required capability is not available.

CapabilityException(HasName, String) - Constructor for exception ztex.CapabilityException

Constructs an instance from a given device and capability string.

capabilityInfo(String) - Method in class ztex.Ztex1v1

Creates a String with capability information.

capabilityStrings - Static variable in class ztex.Ztex1v1

The names of the capabilities

checkCapability(int, int) - Method in class ztex.Ztex1v1

Checks whether ZTEX descriptor 1 is available and interface 1 and a given capability are supported.

checkCapability(int) - Method in class ztex.Ztex1v1

Checks whether ZTEX descriptor 1 is available and interface 1 and a given capability are supported.

checkCompatible(int, int, int, int) - Method in class ztex.Ztex1v1

Checks whether the given product ID is compatible to the device corresponding to this class and whether interface 1 is supported.

checkValid() - Method in class ztex.Ztex1

Checks whether ZTEX descriptor 1 is available.

checkValid() - Method in class ztex.Ztex1v1

Checks whether ZTEX descriptor 1 is available and interface 1 is supported.

claimInterface(int) - Method in class ztex.Ztex1

Claims an interface.

compatible(int, int, int, int) - Method in class ztex.Ztex1v1

Checks whether the given product ID is compatible to the device corresponding to this class and whether interface 1 is supported.

compatible(int, int, int, int) - Method in class ztex.ZtexDevice1

Checks whether the given product ID is compatible to the device.

config - Variable in class ztex.Ztex1v1

The configuration data structure is initialized if this kind of data is present in MAC EEPROM or in (firmware) EEPROM.

ConfigData - Class in ztex

This class represents the configuration data space of ZTEX FPGA Boards that support it.

ConfigData() - Constructor for class ztex.ConfigData

Constructs an empty instance.

ConfigData(Ztex1v1) - Constructor for class ztex.ConfigData

Constructs an instance and connects it with z.

configureFpga(InputStream, boolean, int) - Method in class ztex.Ztex1v1

Upload a Bitstream to the FPGA using high speed mode (if available) or low speed mode.

configureFpga(String, boolean, int) - Method in class ztex.Ztex1v1

Upload a Bitstream to the FPGA using high speed mode (if available) or low speed mode.

configureFpga(String, boolean) - Method in class ztex.Ztex1v1

Upload a Bitstream to the FPGA using high speed mode (if available) or low speed mode.

configureFpgaHS(InputStream, boolean, int) - Method in class ztex.Ztex1v1

Upload a Bitstream to the FPGA using high speed mode.

configureFpgaHS(String, boolean, int) - Method in class ztex.Ztex1v1

Upload a Bitstream to the FPGA using high speed mode.

configureFpgaLS(InputStream, boolean, int) - Method in class ztex.Ztex1v1

Upload a Bitstream to the FPGA using low speed mode.

configureFpgaLS(String, boolean, int) - Method in class ztex.Ztex1v1

Upload a Bitstream to the FPGA using low speed mode.

connect(Ztex1v1) - Method in class ztex.ConfigData

Reads the configuration data (if existent) from a device and connects it to this instance.

context() - Method in class ztex.ZtexContext

Returns the USB context.

context() - Method in class ztex.ZtexDevice1

Returns the USB context of the device.

controlMsgTimeout - Variable in class ztex.Ztex1

The timeout for control messages in ms.

cypressProductIdBuggy - Static variable in class ztex.ZtexDevice1

Product ID of buggy FX3 devices (datecode 1149)

cypressProductIdFx2 - Static variable in class ztex.ZtexDevice1

EZ-USB USB FX2 product ID: 0x8613

cypressProductIdFx3 - Static variable in class ztex.ZtexDevice1

EZ-USB USB FX3 product ID: 0x00f3

cypressVendorId - Static variable in class ztex.ZtexDevice1

Cypress vendor ID: 0x4b4

cypressVendorIdBuggy - Static variable in class ztex.ZtexDevice1

Vendor ID of buggy FX3 devices (datecode 1149)

D

data() - Method in class ztex.ConfigData

Returns a copy of the configuration data array.

data - Variable in class ztex.ImgFile

This array stores the firmware image.

dataInfo(PrintStream) - Method in class ztex.ImgFile

Print out some information about the memory usage.

debug2Cnt() - Method in class ztex.Ztex1v1

Returns the number of messages in buffer.

debug2EC() - Method in class ztex.Ztex1v1

Returns an error code if a fatal error occurred (0 if no error occurred)

debug2GetMessage(int) - Method in class ztex.Ztex1v1

Reads a debug message with given Index in raw format.

debug2GetNextLogMessage() - Method in class ztex.Ztex1v1

Reads the next log message in string format.

debug2LastIdx() - Method in class ztex.Ztex1v1

Returns index of last message + 1

debug2LogIdx - Variable in class ztex.Ztex1v1

Index of next log entry (messages of type 1 and 2) to be read.

debug2PrintNextLogMessages(PrintStream) - Method in class ztex.Ztex1v1

Prints new log message.

debugLastMsg() - Method in class ztex.Ztex1v1

Returns the number of the last message read out by Ztex1v1.debugReadMessages(boolean,byte[])

debugLog - Static variable in class ztex.SimpleLogger

Default logger for debug messages.

debugMsgSize() - Method in class ztex.Ztex1v1

Returns the size of messages in bytes.

debugNewMessages - Variable in class ztex.Ztex1v1

Is set by Ztex1v1.debugReadMessages(boolean,byte[]) and contains the number of new messages.

debugReadMessages(boolean, byte[]) - Method in class ztex.Ztex1v1

Reads debug messages from message stack.

debugStackSize() - Method in class ztex.Ztex1v1

Returns the size of message stack in messages.

defaultBitstreamPath(String, int) - Method in class ztex.ConfigData

Returns the bitstream path if the same directory scheme as for the examples is used.

defaultCheckVersion(int) - Method in class ztex.Ztex1v1

Checks version of the default interface.

defaultDisableWarnings - Variable in class ztex.Ztex1v1

disable update warnings.

defaultGpioCtl(int, int) - Method in class ztex.Ztex1v1

Reads and modifies the 4 GPIO pins.

defaultInEP() - Method in class ztex.Ztex1v1

Returns input Endpoint of default interface used for high speed communication.

defaultLatestSubVersion - Variable in class ztex.Ztex1v1

sub-version number of the latest default interface.

defaultLatestVersion - Variable in class ztex.Ztex1v1

version number of the latest default interface.

defaultLsiGet(int) - Method in class ztex.Ztex1v1

Read data from the low speed interface of default firmwares.

defaultLsiGet(int, int[], int) - Method in class ztex.Ztex1v1

Read data from the low speed interface of default firmwares.

defaultLsiSet(int, int) - Method in class ztex.Ztex1v1

Send data to the low speed interface of default firmwares.

defaultLsiSet(int, int[], int) - Method in class ztex.Ztex1v1

Send data to the low speed interface of default firmwares.

defaultLsiSet(int[], int[], int) - Method in class ztex.Ztex1v1

Send data to the low speed interface of default firmwares.

defaultOutEP() - Method in class ztex.Ztex1v1

Returns output Endpoint of default interface used for high speed communication.

defaultReset(boolean) - Method in class ztex.Ztex1v1

Assert the reset signal.

defaultReset() - Method in class ztex.Ztex1v1

Assert the reset signal.

defaultSubVersion() - Method in class ztex.Ztex1v1

Returns sub-version of the default interface.

defaultVersion() - Method in class ztex.Ztex1v1

Returns version of the default interface or 0 if default interface is not present.

dev() - Method in class ztex.Ztex1

Returns the corresponding ZtexDevice1.

dev() - Method in class ztex.ZtexDevice1

Returns the USB device.

device(int) - Method in class ztex.ZtexScanBus1

Returns a device from the list of devices.

DeviceLostException - Exception in ztex

Thrown if a device went lost after renumeration.

DeviceLostException(String) - Constructor for exception ztex.DeviceLostException

Constructs an instance from the given input string.

DeviceLostException() - Constructor for exception ztex.DeviceLostException

Constructs an instance using a standard message.

DeviceNotSupportedException - Exception in ztex

Thrown if a device is not supported, i.e. has the wrong USB ID's.

DeviceNotSupportedException(Device) - Constructor for exception ztex.DeviceNotSupportedException

Constructs an instance from the given device.

disconnect() - Method in class ztex.ConfigData

Disconnects the currently connected device.

dispose() - Method in class ztex.Ztex1

This should be called if the class is not used anymore.

E

eepromBytes - Variable in class ztex.Ztex1v1

Number of bytes written to EEPROM.

eepromChecksum - Variable in class ztex.Ztex1v1

Checksum of the last EEPROM transfer.

eepromConfigSpaceStartAddr - Static variable in class ztex.Ztex1v1

If no MAC-EEPROM is present configuration data is stored at this address in (firmware) EEPROM.

eepromDisable() - Method in class ztex.Ztex1v1

Deprecated.

Replaced by Ztex1v1.nvDisableFirmware()

eepromRead(int, byte[], int) - Method in class ztex.Ztex1v1

Reads data from the EEPROM.

eepromState() - Method in class ztex.Ztex1v1

Reads the current EEPROM status.

eepromUpload(ImgFile, boolean) - Method in class ztex.Ztex1v1

Deprecated.

Replaced by Ztex1v1.nvUploadFirmware(String,boolean) Upload the firmware to the non-volatile memory. In order to start the uploaded firmware the device must be reset.

eepromUpload(String, boolean) - Method in class ztex.Ztex1v1

Deprecated.

Replaced by Ztex1v1.nvUploadFirmware(String,boolean) Upload the firmware to the non-volatile memory. In order to start the uploaded firmware the device must be reset.

eepromWrite(int, byte[], int) - Method in class ztex.Ztex1v1

Writes data to the EEPROM.

enableExtraFpgaConfigurationChecks - Variable in class ztex.Ztex1v1

Enables extra FPGA configuration checks.

err - Static variable in class ztex.SimpleLogger

Default logger for errors.

errStr(int) - Static method in class ztex.Fx3Errors

Return FX3 runtime error string.

EzUsb - Class in ztex

Provides methods for uploading firmware to Cypress EZ-USB devices.

EzUsb() - Constructor for class ztex.EzUsb

F

finalize() - Method in class ztex.Ztex1

Releases all resources.

finalize() - Method in class ztex.ZtexContext

Releases all resources.

finalize() - Method in class ztex.ZtexDevice1

Releases all resources.

finalize() - Method in class ztex.ZtexScanBus1

Releases all resources.

FirmwareUploadException - Exception in ztex

Signals that an error occurred while attempting to upload the firmware.

FirmwareUploadException(Object, String) - Constructor for exception ztex.FirmwareUploadException

Constructs an instance from the given error message.

FirmwareUploadException(Object) - Constructor for exception ztex.FirmwareUploadException

Constructs an instance using a standard message.

flash2EC - Variable in class ztex.Ztex1v1

Last 2nd Flash error code obtained by Ztex1v1.flashState().

flash2Enabled() - Method in class ztex.Ztex1v1

Returns true if 2nd Flash memory is installed.

flash2Info() - Method in class ztex.Ztex1v1

Returns information about 2nd Flash memory.

flash2ReadSector(int, int, byte[]) - Method in class ztex.Ztex1v1

Reads a integer number of sectors from the 2nd Flash memory.

flash2ReadSector(int, byte[]) - Method in class ztex.Ztex1v1

Reads one sector from the 2nd Flash memory.

flash2Sectors() - Method in class ztex.Ztex1v1

Returns the number of sectors of the 2nd Flash memory or 0, if no 2nd Flash is installed.

flash2SectorSize() - Method in class ztex.Ztex1v1

Returns the sector size of the 2nd Flash memory or 0, if no 2nd Flash is installed.

flash2Size() - Method in class ztex.Ztex1v1

Returns the size of 2nd Flash memory or 0, if no 2nd Flash memory is installed.

flash2State() - Method in class ztex.Ztex1v1

Reads the the 2nd Flash memory status and information.

flash2StrError() - Method in class ztex.Ztex1v1

Gets the last 2nd Flash error from the device.

flash2WriteSector(int, int, byte[]) - Method in class ztex.Ztex1v1

Writes a integer number of sectors to the 2nd Flash.

flash2WriteSector(int, byte[]) - Method in class ztex.Ztex1v1

Writes one sector to the 2nd Flash memory.

FLASH_EC_BUSY - Static variable in class ztex.Ztex1v1

Signals that Flash memory it busy.

FLASH_EC_BUSY_FPGA - Static variable in class ztex.Ztex1v1

Flash may be in use by FPGA.

FLASH_EC_CMD_ERROR - Static variable in class ztex.Ztex1v1

Signals an error while attempting to execute a command.

FLASH_EC_NO_ERROR - Static variable in class ztex.Ztex1v1

Means no error.

FLASH_EC_NOTSUPPORTED - Static variable in class ztex.Ztex1v1

Signals the installed Flash memory is not supported.

FLASH_EC_PENDING - Static variable in class ztex.Ztex1v1

Signals that another Flash operation is pending.

FLASH_EC_READ_ERROR - Static variable in class ztex.Ztex1v1

Signals an error while attempting to read from Flash.

FLASH_EC_RUNTIME - Static variable in class ztex.Ztex1v1

Signals a runtime error of the firmware.

FLASH_EC_TIMEOUT - Static variable in class ztex.Ztex1v1

Signals that a timeout occurred.

FLASH_EC_WRITE_ERROR - Static variable in class ztex.Ztex1v1

Signals an error while attempting to write to Flash.

flashDownloadUserData(byte[], int) - Method in class ztex.Ztex1v1

Downloads user data from Flash memory.

flashEC - Variable in class ztex.Ztex1v1

Last Flash error code obtained by Ztex1v1.flashState().

flashEnabled() - Method in class ztex.Ztex1v1

Returns true if Flash memory is installed.

flashFirstFreeSector() - Method in class ztex.Ztex1v1

Returns the first free sector of the Flash memory.

flashInfo() - Method in class ztex.Ztex1v1

Returns information about Flash memory.

flashReadSector(int, int, byte[]) - Method in class ztex.Ztex1v1

Reads a integer number of sectors from the Flash.

flashReadSector(int, byte[]) - Method in class ztex.Ztex1v1

Reads one sector from the Flash.

flashResetBitstream() - Method in class ztex.Ztex1v1

Clears a Bitstream from the Flash.

flashSectors() - Method in class ztex.Ztex1v1

Returns the number of sectors of the Flash memory or 0, if no Flash memory is installed.

flashSectorSize() - Method in class ztex.Ztex1v1

Returns the sector size of the Flash memory or 0, if no Flash is installed.

flashSize() - Method in class ztex.Ztex1v1

Returns the size of Flash memory in bytes or 0, if no Flash memory is installed.

flashState() - Method in class ztex.Ztex1v1

Reads the the Flash memory status and information.

flashStrError(int) - Static method in class ztex.Ztex1v1

Converts a given error code into a String.

flashStrError() - Method in class ztex.Ztex1v1

Gets the last Flash error from the device.

flashUploadBitstream(InputStream, int) - Method in class ztex.Ztex1v1

Uploads a Bitstream to the Flash.

flashUploadBitstream(String, int) - Method in class ztex.Ztex1v1

Uploads a Bitstream to the Flash.

flashUploadBitstream(String) - Method in class ztex.Ztex1v1

Uploads a Bitstream to the Flash.

flashUploadUserData(InputStream, int) - Method in class ztex.Ztex1v1

Uploads user data to Flash memory.

flashUploadUserData(String, int) - Method in class ztex.Ztex1v1

Uploads user data to Flash memory.

flashWriteSector(int, int, byte[]) - Method in class ztex.Ztex1v1

Writes a integer number of sectors to the Flash.

flashWriteSector(int, byte[]) - Method in class ztex.Ztex1v1

Writes one sector to the Flash.

fpgas - Static variable in class ztex.ConfigData

FPGA's used on ZTEX FPGA Boards.

fwVersion() - Method in class ztex.ZtexDevice1

Returns the firmware version.

fwVersion() - Method in class ztex.ZtexImgFile1

Returns the firmware version.

fx3() - Method in class ztex.ZtexDevice1

Returns true if device is an FX3

Fx3Errors - Class in ztex

FX3 runtime error strings

Fx3Errors() - Constructor for class ztex.Fx3Errors

G

getBitstreamSize() - Method in class ztex.ConfigData

Returns actual size of bitstream in bytes sectors. 0 means that no bitstream is stored.

getBitstreamStart() - Method in class ztex.ConfigData

Returns bitstream start position in bytes.

getBuffer(byte[], int) - Method in class ztex.ZtexUsbReader

Get the next buffer.

getFlash2EC() - Method in class ztex.Ztex1v1

Gets the last 2nd Flash memory error from the device.

getFlashEC() - Method in class ztex.Ztex1v1

Gets the last Flash error from the device.

getFpga() - Method in class ztex.ConfigData

Returns FPGA information.

getFpgaConfiguration() - Method in class ztex.Ztex1v1

Returns true if the FPGA is configured.

getFpgaConfigurationStr() - Method in class ztex.Ztex1v1

Returns a string that indicates the FPGA configuration status.

getFPGAFlashAccess() - Method in class ztex.ConfigData

Returns whether the FPGA can access Flash.

getInputStream(String) - Static method in class ztex.JInputStream

Creates an InputStream instance from a giving file name.

getInterfaceClaimed(int) - Method in class ztex.Ztex1

Returns true if interface is claimed.

getMajorVersion() - Method in class ztex.ConfigData

Returns the major version number, e.g. 2 for USB-FPGA Modules 2.14b.

getMaxBitstreamSize() - Method in class ztex.ConfigData

Returns maximum size of bitstream in bytes.

getMinorVersion() - Method in class ztex.ConfigData

Returns the minor version number, e.g. 14 for USB-FPGA Modules 2.14b.

getName() - Method in class ztex.ConfigData

Returns the name of the FPGA Board.

getRamSize() - Method in class ztex.ConfigData

Returns RAM size in bytes.

getRamType() - Method in class ztex.ConfigData

Returns RAM type and speed.

getUsb3Errors() - Method in class ztex.Ztex1v1

Reads USB 3.0 errors and stores them in Ztex1v1.usb3SndErrors Ztex1v1.usb3RcvErrors.

getUserData(int) - Method in class ztex.ConfigData

Returns user data at index i.

getVariant() - Method in class ztex.ConfigData

Returns the variant letter, e.g.

H

handle() - Method in class ztex.Ztex1

Returns the USB file handle.

HasName - Interface in ztex

This class implements an interface for objects that have a name (which can be used e.g. in log message)

I

ImgFile - Class in ztex

A class representing a firmware image.

ImgFile(InputStream, String) - Constructor for class ztex.ImgFile

Constructs an instance from a given file name.

ImgFile(String) - Constructor for class ztex.ImgFile

Constructs an instance from a given file name.

ImgFileDamagedException - Exception in ztex

Signals that a firmware image is corrupt.

ImgFileDamagedException(String, int, String) - Constructor for exception ztex.ImgFileDamagedException

Constructs an instance from a given file name, line number and error message.

ImgFileDamagedException(String, String) - Constructor for exception ztex.ImgFileDamagedException

Constructs an instance from a given file name and error message.

ImgParseException - Exception in ztex

Signals that an error occurred while attempting to decode the firmware file.

ImgParseException(String) - Constructor for exception ztex.ImgParseException

Constructs an instance from the given error message.

IncompatibleFirmwareException - Exception in ztex

Thrown while attempting to overwrite an existing firmware with an incompatible one.

IncompatibleFirmwareException(Object, String) - Constructor for exception ztex.IncompatibleFirmwareException

Constructs an instance from the given error message.

IncompatibleFirmwareException(Object) - Constructor for exception ztex.IncompatibleFirmwareException

Constructs an instance using a standard message.

init() - Method in class ztex.Ztex1

Initializates the class.

init() - Method in class ztex.Ztex1v1

Initializates the class.

interfaceCapabilities(int) - Method in class ztex.Ztex1v1

Returns interface capability bit.

interfaceCapabilities() - Method in class ztex.ZtexDevice1

Returns the interface capabilities (all 6 bytes).

interfaceCapabilities(int) - Method in class ztex.ZtexDevice1

Returns byte i of the interface capabilities.

interfaceCapabilities(int, int) - Method in class ztex.ZtexDevice1

Returns byte i, bit j of the interface capabilities.

interfaceCapabilities() - Method in class ztex.ZtexImgFile1

Returns the interface capabilities (all 6 bytes).

interfaceCapabilities(int) - Method in class ztex.ZtexImgFile1

Returns byte i of the interface capabilities.

interfaceVersion() - Method in class ztex.ZtexDevice1

Returns the interface version.

interfaceVersion() - Method in class ztex.ZtexImgFile1

Returns the interface version.

InvalidFirmwareException - Exception in ztex

Thrown if a device runs with no or the wrong firmware, i.e. if the ZTEX descriptor is not found or damaged.

InvalidFirmwareException(Object, String) - Constructor for exception ztex.InvalidFirmwareException

Constructs an instance from the given device and error message.

InvalidFirmwareException(Object) - Constructor for exception ztex.InvalidFirmwareException

Constructs an instance from the given device and error message.

isFx3 - Variable in class ztex.ImgFile

Assumed to be an FX3 firmware.

J

JInputStream - Class in ztex

Creates an input stream from a regular file or a system resource file (i.e. a file from the current jar file).

JInputStream() - Constructor for class ztex.JInputStream

L

log - Static variable in class ztex.SimpleLogger

Default logger for messages.

logLevel - Static variable in class ztex.SimpleLogger

Log level.

M

macEepromRead(int, byte[], int) - Method in class ztex.Ztex1v1

Reads data from the MAC EEPROM.

macEepromState() - Method in class ztex.Ztex1v1

Reads the current MAC EEPROM status.

macEepromWrite(int, byte[], int) - Method in class ztex.Ztex1v1

Writes data to the MAC EEPROM.

macRead(byte[]) - Method in class ztex.Ztex1v1

Reads MAC address from MAC EEPROM.

manufacturerString() - Method in class ztex.ZtexDevice1

Returns the manufacturer string of the device.

moduleReserved() - Method in class ztex.ZtexDevice1

Returns the application specific information (all 12 bytes).

moduleReserved(int) - Method in class ztex.ZtexDevice1

Returns byte i of the application specific information.

moduleReserved() - Method in class ztex.ZtexImgFile1

Returns the application specific information (all 12 bytes).

moduleReserved(int) - Method in class ztex.ZtexImgFile1

Returns byte i of the application specific information.

N

name() - Method in interface ztex.HasName

Returns the name of the object which is used e.g in log message.

name() - Method in class ztex.Ztex1

Returns the name of the device which is dev().name()).

name(Device) - Static method in class ztex.ZtexDevice1

Returns a name that identifies a device.

name() - Method in class ztex.ZtexDevice1

Returns a name that identifies the device.

numberOfDevices() - Method in class ztex.ZtexScanBus1

Returns the number of devices found.

numberOfFpgas() - Method in class ztex.Ztex1v1

Returns the number of FPGA's

nvDisableFirmware() - Method in class ztex.Ztex1v1

Disables the firmware stored in the non-volatile memory.

nvUploadFirmware(ImgFile, boolean) - Method in class ztex.Ztex1v1

Upload the firmware to the non-volatile memory.

nvUploadFirmware(String, boolean) - Method in class ztex.Ztex1v1

Upload the firmware to the non-volatile memory.

P

packages - Static variable in class ztex.ConfigData

FPGA packages used on ZTEX FPGA boards.

print(String) - Method in class ztex.SimpleLogger

Writes a log message without finishing the line.

printBus(PrintStream) - Method in class ztex.ZtexScanBus1

Prints out a list of devices found.

printFpgaState() - Method in class ztex.Ztex1v1

Prints out the FPGA state.

println() - Method in class ztex.SimpleLogger

Prints a new line.

println(String) - Method in class ztex.SimpleLogger

Writes a log message and finishes the line.

printMmc2State() - Method in class ztex.Ztex1v1

Prints out some debug information about *SD/MMC Flash cards in SPI mode.

printMmcState() - Method in class ztex.Ztex1v1

Prints out some debug information about *SD/MMC Flash cards in SPI mode.

printSpiState() - Method in class ztex.Ztex1v1

Prints out some debug information about SPI Flash.

productId() - Method in class ztex.ZtexDevice1

Returns the product ID (all 4 bytes).

productId(int) - Method in class ztex.ZtexDevice1

Returns byte i of the product ID.

productId() - Method in class ztex.ZtexImgFile1

Returns the product ID (all 4 bytes).

productId(int) - Method in class ztex.ZtexImgFile1

Returns byte i of the product ID.

productString() - Method in class ztex.ZtexDevice1

Returns the product string of the device.

R

ramTypes - Static variable in class ztex.ConfigData

RAM types and speed used on ZTEX FPGA boards.

ref() - Method in class ztex.ZtexContext

Increases the reference count.

ref() - Method in class ztex.ZtexDevice1

Increases reference counter.

ref() - Method in class ztex.ZtexScanBus1

Increases reference counter.

releaseInterface(int) - Method in class ztex.Ztex1

Releases an interface.

resetDevice(boolean) - Method in class ztex.Ztex1

Performs a configuration or bus reset.

resetEzUsb() - Method in class ztex.Ztex1

Resets the EZ-USB and manages the renumeration process.

resetEzUsb() - Method in class ztex.Ztex1v1

Resets the EZ-USB and manages the renumeration process.

resetFpga() - Method in class ztex.Ztex1v1

Resets the FPGA.

resetFx2(Object, DeviceHandle, boolean) - Static method in class ztex.EzUsb

Controls the reset state of a Cypress EZ-USB device.

run() - Method in class ztex.ZtexEventHandler

The thread body.

S

selectFpga(int) - Method in class ztex.Ztex1v1

Select a FPGA

sendtUserData() - Method in class ztex.ConfigData

Sends the user data to the FPGA Board.

setBitstreamSize(int) - Method in class ztex.ConfigData

Sets the actual size of bitstream in bytes.

setBitstreamStart(int) - Method in class ztex.ConfigData

Sets the start position of the bitstream in 4 KByte sectors.

setConfiguration(int) - Method in class ztex.Ztex1

Sets the configuration.

setFpga(String, String, String) - Method in class ztex.ConfigData

Sets FPGA information.

setFPGAFlashAccess(boolean) - Method in class ztex.ConfigData

Sets whether the FPGA can access Flash.

setMaxBitstreamSize(int) - Method in class ztex.ConfigData

Sets the maximum size of bitstream in 4 KByte sectors.

setName(String, int, int, String) - Method in class ztex.ConfigData

Sets the name of the FPGA Board.

setName(String) - Method in class ztex.ZtexDevice1

Set the name of the device which is returned by ZtexDevice1.name().

setProductString(String) - Method in class ztex.ConfigData

Sets the product string.

setRam(int, String) - Method in class ztex.ConfigData

Sets RAM information.

setSN(String) - Method in class ztex.ConfigData

Sets the serial number.

setSnString(String) - Method in class ztex.ZtexImgFile1

Modifies the serial number string.

setUsbIDs(int, int) - Method in class ztex.ConfigData

Set the USB vendor vendor and product ID.

setUserData(int, byte) - Method in class ztex.ConfigData

Sets user data at index i to value v.

SimpleLogger - Class in ztex

This class provides simple logging functionality.

SimpleLogger(int) - Constructor for class ztex.SimpleLogger

Creates the default logger for a certain log level.

snString() - Method in class ztex.ZtexDevice1

Returns the serial number string of the device.

snString() - Method in class ztex.ZtexImgFile1

Returns the serial number string.

start(long) - Method in class ztex.ZtexUsbReader

Start the reader.

startVector - Variable in class ztex.ImgFile

Start vector.

T

tempSensorRead(int) - Method in class ztex.Ztex1v1

Read temperature sensor data.

tempSensorUpdateInterval - Variable in class ztex.Ztex1v1

smallest temperature sensor update interval in ms

terminate() - Method in class ztex.ZtexEventHandler

Stops the event handler.

toHumanStr(long) - Method in class ztex.Ztex1v1

Converts an integer into a base 1024 formatted string.

toString() - Method in class ztex.Ztex1

Returns a lot of useful information about the corresponding device.

toString() - Method in class ztex.Ztex1v1

Returns a lot of useful information about the corresponding device.

toString() - Method in class ztex.ZtexDevice1

Returns a string representation if the device with a lot of useful information.

toString() - Method in class ztex.ZtexImgFile1

Returns a string representation if the instance.

transferStatus() - Method in class ztex.ZtexUsbReader

Return status of current transfer (see LibUsb.TRANSFER_*), -1 if transfer is pending or -2 if transfer has not been started.

transmitBuffer(byte[], int, int) - Method in class ztex.ZtexUsbWriter

Transmit the next buffer.

transmitBuffer(byte[], int) - Method in class ztex.ZtexUsbWriter

Transmit the next buffer.

trySetConfiguration(int) - Method in class ztex.Ztex1

Tries to set the configuration.

U

uncompressAddr(int) - Static method in class ztex.ImgFile

Uncompresses the FX3 address space.

unref() - Method in class ztex.ZtexContext

Decreases the reference count and releases the context if reference counter reaches 0.

unref() - Method in class ztex.ZtexDevice1

Decreases reference counter and rleases resources if 0 is reached.

unref() - Method in class ztex.ZtexScanBus1

Decreases reference counter and releases resources if 0 is reached.

uploadFirmware(Object, DeviceHandle, ImgFile) - Static method in class ztex.EzUsb

Uploads the Firmware to a Cypress EZ-USB device.

uploadFirmware(ZtexImgFile1, boolean) - Method in class ztex.Ztex1

Uploads the firmware to the EZ-USB and manages the renumeration process.

uploadFirmware(String, boolean) - Method in class ztex.Ztex1

Uploads the firmware to the EZ-USB and manages the renumeration process.

uploadFirmware(InputStream, String, boolean) - Method in class ztex.Ztex1

Uploads the firmware to the EZ-USB and manages the renumeration process.

usb3RcvErrors - Variable in class ztex.Ztex1v1

USB 3.0 receive error count.

usb3SndErrors - Variable in class ztex.Ztex1v1

USB 3.0 send error count.

UsbException - Exception in ztex

Signals an USB error.

UsbException(Object, String) - Constructor for exception ztex.UsbException

Constructs an instance from the given device, error message and error number.

UsbException(Object, String, int) - Constructor for exception ztex.UsbException

Constructs an instance from the given device, error message and error number.

usbProductId() - Method in class ztex.ZtexDevice1

Returns the USB product ID of the device.

usbTimeOut - Variable in class ztex.ZtexUsbReader

usbVendorId() - Method in class ztex.ZtexDevice1

Returns the USB vendor ID of the device.

V

valid() - Method in class ztex.Ztex1

Returns true if ZTEX descriptor 1 is available.

valid() - Method in class ztex.Ztex1v1

Returns true if ZTEX interface 1 is available.

valid(int, int) - Method in class ztex.Ztex1v1

Returns true if ZTEX interface 1 and capability i.j are available.

valid() - Method in class ztex.ZtexDevice1

Returns true if ZTEX descriptor 1 is available.

vendorCommand(int, String, int, int, ByteBuffer) - Method in class ztex.Ztex1

Sends a vendor command to Endpoint 0 of the EZ-USB device.

vendorCommand(int, String, int, int, byte[], int) - Method in class ztex.Ztex1

Sends a vendor command to Endpoint 0 of the EZ-USB device.

vendorCommand(int, String, int, int) - Method in class ztex.Ztex1

Sends a vendor command with no payload data to Endpoint 0 of the EZ-USB device.

vendorCommand(int, String) - Method in class ztex.Ztex1

Sends a vendor command with no payload data and no setup data to Endpoint 0 of the EZ-USB device.

vendorCommand2(int, String, int, int, ByteBuffer) - Method in class ztex.Ztex1

Sends a vendor command to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been sent.

vendorCommand2(int, String, int, int, byte[], int) - Method in class ztex.Ztex1

Sends a vendor command to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been sent.

vendorCommand3(int, String, int, int, ByteBuffer) - Method in class ztex.Ztex1

Sends a vendor command to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been sent after one retry.

vendorCommand3(int, String, int, int, byte[], int) - Method in class ztex.Ztex1

Sends a vendor command to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been sent after one retry.

vendorRequest(int, String, int, int, ByteBuffer) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device.

vendorRequest(int, String, int, int, byte[], int) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device.

vendorRequest(int, String, ByteBuffer) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device.

vendorRequest(int, String, byte[], int) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device.

vendorRequest2(int, String, ByteBuffer) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been received.

vendorRequest2(int, String, int, int, byte[], int) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been received.

vendorRequest2(int, String, byte[], int) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been received.

vendorRequest3(int, String, ByteBuffer) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been received after one retry.

vendorRequest3(int, String, int, int, byte[], int) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been received after one retry.

vendorRequest3(int, String, byte[], int) - Method in class ztex.Ztex1

Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an UsbException if not all of the payload has been received after one retry.

W

wait(int) - Method in class ztex.ZtexUsbWriter

Waits until all pending transfers are finished or canceled.

X

XMEGA_EC_ADDRESS_ERROR - Static variable in class ztex.Ztex1v1

Signals an address error (invalid address or wrong page size).

XMEGA_EC_INVALID_DEVICE - Static variable in class ztex.Ztex1v1

Signals that the ATxmega controller is not supported.

XMEGA_EC_NO_ERROR - Static variable in class ztex.Ztex1v1

Means no error.

XMEGA_EC_NVM_BUSY - Static variable in class ztex.Ztex1v1

Signals that the NVM is busy.

XMEGA_EC_NVM_TIMEOUT - Static variable in class ztex.Ztex1v1

Signals that an NVM timeout occurred.

XMEGA_EC_PDI_READ_ERROR - Static variable in class ztex.Ztex1v1

Signals a PDI read error.

xmegaEC - Variable in class ztex.Ztex1v1

Last ATxmega error code obtained by Ztex1v1.xmegaState().

xmegaEepromPages() - Method in class ztex.Ztex1v1

Returns the number of the ATxmega EEPROM pages.

xmegaEepromPageSize() - Method in class ztex.Ztex1v1

Returns the size of the ATXmega EEPROM pages.

xmegaEepromPageWrite(int, byte[]) - Method in class ztex.Ztex1v1

Writes data to EEPROM memory of ATxmega.

xmegaEepromRead(int, byte[], int) - Method in class ztex.Ztex1v1

Reads data from EEPROM memory of ATxmega.

xmegaEnabled() - Method in class ztex.Ztex1v1

Returns true if ATxmega controller is available.

xmegaFlashPages() - Method in class ztex.Ztex1v1

Returns the number of the ATxmega Flash pages.

xmegaFlashPageSize() - Method in class ztex.Ztex1v1

Returns the size of the ATxmega Flash pages.

xmegaFlashPageWrite(int, byte[]) - Method in class ztex.Ztex1v1

Writes data to Flash memory of ATxmega.

xmegaFlashRead(int, byte[], int) - Method in class ztex.Ztex1v1

Reads data from Flash memory of ATxmega.

xmegaFuseRead(int, byte[], int) - Method in class ztex.Ztex1v1

Reads data from Fuse memory of ATxmega.

xmegaFuseRead(int) - Method in class ztex.Ztex1v1

Reads data one Fuse of ATxmega.

xmegaFuseWrite(int, int) - Method in class ztex.Ztex1v1

Writes one Fuse of the ATxmega.

xmegaNvmRead(int, byte[], int) - Method in class ztex.Ztex1v1

Reads data from the NVM of ATxmega.

xmegaReset() - Method in class ztex.Ztex1v1

Resets the ATxmega.

xmegaState() - Method in class ztex.Ztex1v1

Read ATxmega error and status information from the device.

xmegaStrError(int) - Method in class ztex.Ztex1v1

Converts a given error code into a String.

xmegaStrError() - Method in class ztex.Ztex1v1

Gets the last ATxmega error from the device.

xmegaWriteEeprom(ImgFile) - Method in class ztex.Ztex1v1

Uploads data to the EEPROM memory

xmegaWriteFirmware(ImgFile) - Method in class ztex.Ztex1v1

Uploads firmware to the flash memory

Z

ztex - package ztex

The Java API of the ZTEX SDK.

Ztex1 - Class in ztex

This class implements the interface-independent part of the communication protocol for the interaction with the ZTEX firmware.

Ztex1(ZtexDevice1) - Constructor for class ztex.Ztex1

Constructs an instance from a given device.

Ztex1v1 - Class in ztex

This class implements the communication protocol of the interface version 1 for the interaction with the ZTEX firmware.

Ztex1v1(ZtexDevice1) - Constructor for class ztex.Ztex1v1

Constructs an instance from a given device.

ZtexContext - Class in ztex

This class manages an USB context.

ZtexContext() - Constructor for class ztex.ZtexContext

Constructs an new USB context and initializes it.

ZtexDevice1 - Class in ztex

A class representing an EZ-USB device that supports the ZTEX descriptor 1 or an unconfigured EZ-USB device.

ZtexDevice1(ZtexContext, Device, int, int, boolean) - Constructor for class ztex.ZtexDevice1

Constructs an instance from a given USB device.

ZtexEventHandler - Class in ztex

This class defines an event handler thread which can be used in asynchronous mode.

ZtexEventHandler(Context) - Constructor for class ztex.ZtexEventHandler

Creates the event handler for a given USB context.

ZtexEventHandler(Ztex1) - Constructor for class ztex.ZtexEventHandler

Creates the event handler for a given ZTEX device.

ZtexException - Exception in ztex

An exception generated by an object that has a name (for better logging).

ZtexException(Object, String) - Constructor for exception ztex.ZtexException

Constructs an instance from the given error message.

ZtexImgFile1 - Class in ztex

Represents a firmware image with ZTEX descriptor 1.

ZtexImgFile1(InputStream, String) - Constructor for class ztex.ZtexImgFile1

Constructs an instance from a given file name and descriptor position.

ZtexImgFile1(String) - Constructor for class ztex.ZtexImgFile1

Constructs an instance from a given file name.

ztexProductId - Static variable in class ztex.ZtexDevice1

USB product ID for ZTEX devices that support ZTEX descriptor 1: 0x100.

ztexProductIdMax - Static variable in class ztex.ZtexDevice1

Largest USB product ID for ZTEX devices that support ZTEX descriptor 1: 0x1ff.

ZtexScanBus1 - Class in ztex

A class for scanning the USB for EZ-USB devices.

ZtexScanBus1(int, int, boolean, boolean, int, String, int, int, int, int) - Constructor for class ztex.ZtexScanBus1

Scans the USB for suitable devices and constructs a list of them.

ZtexScanBus1(int, int, boolean, boolean, int, String) - Constructor for class ztex.ZtexScanBus1

Scans the USB for suitable devices and constructs a list of them.

ZtexScanBus1(int, int, boolean, boolean, int) - Constructor for class ztex.ZtexScanBus1

Scans the USB for suitable devices and constructs a list of them.

ZtexScanBus1(int, int, boolean, boolean) - Constructor for class ztex.ZtexScanBus1

Scans the USB for suitable devices and constructs a list of them.

ZtexUsbReader - Class in ztex

A helper class to implement asynchronous bulk and interrupt read transfers.

ZtexUsbReader(DeviceHandle, int, boolean, int, int) - Constructor for class ztex.ZtexUsbReader

Creates the reader for a given USB device and endpoint number.

ZtexUsbReader(Ztex1, int, boolean, int, int) - Constructor for class ztex.ZtexUsbReader

Creates the reader from a given ZTEX device and endpoint number.

ZtexUsbReader(Ztex1v1, int, int) - Constructor for class ztex.ZtexUsbReader

Creates the reader for the input endpoint of the default interface of a ZTEX device.

ZtexUsbWriter - Class in ztex

A helper class to implement asynchronous bulk and interrupt write transfers.

ZtexUsbWriter(DeviceHandle, int, boolean, int, int) - Constructor for class ztex.ZtexUsbWriter

Creates the writer for a given USB device and endpoint number.

ZtexUsbWriter(Ztex1, int, boolean, int, int) - Constructor for class ztex.ZtexUsbWriter

Creates the writer from a given ZTEX device and endpoint number.

ZtexUsbWriter(Ztex1v1, int, int) - Constructor for class ztex.ZtexUsbWriter

Creates the writer for the input endpoint of the default interface of a ZTEX device.

ztexVendorId - Static variable in class ztex.ZtexDevice1

ZTEX vendor ID: 0x221a

A B C D E F G H I J L M N P R S T U V W X Z