| Line 18... |
Line 18... |
|
|
/*
|
/*
|
Functions for USB devices with ZTEX descriptor 1, Interface 1
|
Functions for USB devices with ZTEX descriptor 1, Interface 1
|
Interface capabilities and vendor requests (VR) / commands (VC):
|
Interface capabilities and vendor requests (VR) / commands (VC):
|
0.0 : EEPROM support
|
0.0 : EEPROM support
|
|
VR 0x38 : read from EEPROM
|
|
Returns:
|
|
EEPROM data
|
|
VC 0x39 : write to EEPROM
|
|
VR 0x3a : EEPROM state
|
|
Returns:
|
|
Offs Description
|
|
0-1 bytes written
|
|
2 checksum
|
|
3 0:idle, 1:busy or error
|
|
|
0.1 : FPGA Configuration
|
0.1 : FPGA Configuration
|
VR 0x31 : FPGA state
|
VR 0x30 : get FPGA state
|
Returns:
|
Returns:
|
Offs Description
|
Offs Description
|
0 1: unconfigured, 0:configured
|
0 1: unconfigured, 0:configured
|
1 checksum
|
1 checksum
|
2-5 transfered bytes
|
2-5 transferred bytes
|
6 INIT_B state
|
6 INIT_B state
|
|
VC 0x31 : reset FPGA
|
|
VC 0x32 : send FPGA configuration data (Bitstream)
|
|
|
|
0.2 : Flash memory support
|
|
VR 0x40 : Flash state
|
|
Returns:
|
|
Offs Description
|
|
0 1:enabled, 0:disabled
|
|
1-2 Sector size
|
|
3-6 Number of sectors
|
|
7 Error code
|
|
VR 0x41 : read from Flash
|
|
VR 0x42 : write to Flash
|
*/
|
*/
|
package ztex;
|
package ztex;
|
|
|
import java.io.*;
|
import java.io.*;
|
import java.util.*;
|
import java.util.*;
|
|
|
import ch.ntb.usb.*;
|
import ch.ntb.usb.*;
|
|
|
|
/**
|
|
* This class implements the communication protocol of the interface version 1 for the interaction with the ZTEX firmware.
|
|
* <p>
|
|
* The features supported by this interface can be accessed via vendor commands and vendor requests via Endpoint 0.
|
|
* Each feature can be enabled or disabled by the firmware and also depends from the hardware.
|
|
* The presence of a feature is indicated by a 1 in the corresponding feature bit of the ZTEX descriptor 1, see {@link ZtexDevice1}.
|
|
* The following table gives an overview about the features
|
|
* <table bgcolor="#404040" cellspacing=1 cellpadding=10>
|
|
* <tr>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Capability bit</b></td>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">0.0</td>
|
|
* <td bgcolor="#ffffff" valign="top" colspan=2>
|
|
* EEPROM support<p>
|
|
* <table bgcolor="#404040" cellspacing=1 cellpadding=6>
|
|
* <tr>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Vendor request (VR)<br> or command (VC)</b></td>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">VR 0x38</td>
|
|
* <td bgcolor="#ffffff" valign="top">Read from EEPROM</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">VC 0x39</td>
|
|
* <td bgcolor="#ffffff" valign="top">Write to EEPROM</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">VR 0x3a</td>
|
|
* <td bgcolor="#ffffff" valign="top">Get EEPROM state. Returns:
|
|
* <table bgcolor="#404040" cellspacing=1 cellpadding=4>
|
|
* <tr>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Bytes</b></td>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">0-1</td>
|
|
* <td bgcolor="#ffffff" valign="top">Number of bytes written.</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">2</td>
|
|
* <td bgcolor="#ffffff" valign="top">Checksum</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">3</td>
|
|
* <td bgcolor="#ffffff" valign="top">0:idle, 1:busy or error</td>
|
|
* </tr>
|
|
* </table>
|
|
* </td>
|
|
* </tr>
|
|
* </table>
|
|
* </td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">0.1</td>
|
|
* <td bgcolor="#ffffff" valign="top" colspan=2>
|
|
* FPGA Configuration<p>
|
|
* <table bgcolor="#404040" cellspacing=1 cellpadding=6>
|
|
* <tr>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Vendor request (VR)<br> or command (VC)</b></td>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">VR 0x30</td>
|
|
* <td bgcolor="#ffffff" valign="top">Get FPGA state. Returns:
|
|
* <table bgcolor="#404040" cellspacing=1 cellpadding=4>
|
|
* <tr>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Bytes</b></td>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">0</td>
|
|
* <td bgcolor="#ffffff" valign="top">1: unconfigured, 0:configured</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">1</td>
|
|
* <td bgcolor="#ffffff" valign="top">Checksum</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">2-5</td>
|
|
* <td bgcolor="#ffffff" valign="top">Number of bytes transferred.</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">6</td>
|
|
* <td bgcolor="#ffffff" valign="top">INIT_B states (Must be 222).</td>
|
|
* </tr>
|
|
* </table>
|
|
* </td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">VC 0x31</td>
|
|
* <td bgcolor="#ffffff" valign="top">Reset FPGA</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">VR 0x32</td>
|
|
* <td bgcolor="#ffffff" valign="top">Send Bitstream</td>
|
|
* </tr>
|
|
* </table>
|
|
* </td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">0.2</td>
|
|
* <td bgcolor="#ffffff" valign="top" colspan=2>
|
|
* Flash memory support<p>
|
|
* <table bgcolor="#404040" cellspacing=1 cellpadding=6>
|
|
* <tr>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Vendor request (VR)<br> or command (VC)</b></td>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">VR 0x40</td>
|
|
* <td bgcolor="#ffffff" valign="top">Get Flash state. Returns:
|
|
* <table bgcolor="#404040" cellspacing=1 cellpadding=4>
|
|
* <tr>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Bytes</b></td>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">0</td>
|
|
* <td bgcolor="#ffffff" valign="top">1:enabled, 0:disabled</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">1-2</td>
|
|
* <td bgcolor="#ffffff" valign="top">Sector size</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">3-6</td>
|
|
* <td bgcolor="#ffffff" valign="top">Number of sectors</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">7</td>
|
|
* <td bgcolor="#ffffff" valign="top">Error code</td>
|
|
* </tr>
|
|
* </table>
|
|
* </td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">VR 0x41</td>
|
|
* <td bgcolor="#ffffff" valign="top">Read one sector from Flash</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">VC 0x42</td>
|
|
* <td bgcolor="#ffffff" valign="top">Write one sector to Flash</td>
|
|
* </tr>
|
|
* </table>
|
|
* </td>
|
|
* </tr>
|
|
* </table>
|
|
* @see ZtexDevice1
|
|
* @see Ztex1
|
|
*/
|
|
|
public class Ztex1v1 extends Ztex1 {
|
public class Ztex1v1 extends Ztex1 {
|
|
/** * The names of the capabilities */
|
public static final String capabilityStrings[] = {
|
public static final String capabilityStrings[] = {
|
"EEPROM read/write" ,
|
"EEPROM read/write" ,
|
"FPGA configuration"
|
"FPGA configuration" ,
|
|
"Flash memory support"
|
};
|
};
|
|
|
public boolean certainWorkarounds = false; // setting to true will enable certain workarounds which may be required for vmware + windows
|
|
|
|
private boolean fpgaConfigured = false;
|
private boolean fpgaConfigured = false;
|
private int fpgaChecksum = 0;
|
private int fpgaChecksum = 0;
|
private int fpgaBytes = 0;
|
private int fpgaBytes = 0;
|
private int fpgaInitB = 0;
|
private int fpgaInitB = 0;
|
|
|
|
/** * Number of bytes written to EEPROM. (Obtained by {@link #eepromState()}.) */
|
public int eepromBytes = 0;
|
public int eepromBytes = 0;
|
|
/** * Checksum of the last EEPROM transfer. (Obtained by {@link #eepromState()}.) */
|
public int eepromChecksum = 0;
|
public int eepromChecksum = 0;
|
public boolean eepromReady = true;
|
|
|
private int flashEnabled = -1;
|
|
private int flashSectorSize = -1;
|
|
private int flashSectors = -1;
|
|
|
|
/** * Last Flash error code obtained by {@link #flashState()}. See FLASH_EC_* for possible error codes. */
|
|
public int flashEC = 0;
|
|
/** * Means no error. */
|
|
public static final int FLASH_EC_NO_ERROR = 0;
|
|
/** * Signals an error while attempting to execute a command. */
|
|
public static final int FLASH_EC_CMD_ERROR = 1;
|
|
/** * Signals that a timeout occurred. */
|
|
public static final int FLASH_EC_TIMEOUT = 2;
|
|
/** * Signals that Flash memory it busy. */
|
|
public static final int FLASH_EC_BUSY = 3;
|
|
/** * Signals that another Flash operation is pending. */
|
|
public static final int FLASH_EC_PENDING = 4;
|
|
/** * Signals an error while attempting to read from Flash. */
|
|
public static final int FLASH_EC_READ_ERROR = 5;
|
|
/** * Signals an error while attempting to write to Flash. */
|
|
public static final int FLASH_EC_WRITE_ERROR = 6;
|
|
|
// ******* Ztex1v1 *************************************************************
|
// ******* Ztex1v1 *************************************************************
|
public Ztex1v1 ( ZtexDevice1 pDev ) throws UsbException, ZtexDescriptorException {
|
/**
|
|
* Constructs an instance from a given device.
|
|
* @param pDev The given device.
|
|
* @throws UsbException if an communication error occurred.
|
|
*/
|
|
public Ztex1v1 ( ZtexDevice1 pDev ) throws UsbException {
|
super ( pDev );
|
super ( pDev );
|
certainWorkarounds = false;
|
|
}
|
}
|
|
|
// ******* valid ***************************************************************
|
// ******* valid ***************************************************************
|
|
/**
|
|
* Returns true if ZTEX interface 1 is available.
|
|
* @return true if ZTEX interface 1 is available.
|
|
*/
|
public boolean valid ( ) {
|
public boolean valid ( ) {
|
return dev.valid() && dev.interfaceVersion()==1;
|
return dev().valid() && dev().interfaceVersion()==1;
|
}
|
}
|
|
|
|
/**
|
|
* Returns true if ZTEX interface 1 and capability i.j are available.
|
|
* @param i byte index of the capability
|
|
* @param j bit index of the capability
|
|
* @return true if ZTEX interface 1 and capability i.j are available.
|
|
*/
|
public boolean valid ( int i, int j) {
|
public boolean valid ( int i, int j) {
|
return dev.valid() && dev.interfaceVersion()==1 && dev.interfaceCapabilities(i,j);
|
return dev().valid() && dev().interfaceVersion()==1 && dev().interfaceCapabilities(i,j);
|
}
|
}
|
|
|
// ******* compatible **********************************************************
|
// ******* compatible **********************************************************
|
|
/**
|
|
* Checks whether the given product ID is compatible to the device corresponding to this class and whether interface 1 is supported.<br>
|
|
* The given product ID is compatible
|
|
* <pre>if ( this.productId(0)==0 || productId0<=0 || this.productId(0)==productId0 ) &&
|
|
( this.productId(0)==0 || productId1<=0 || this.productId(1)==productId1 ) &&
|
|
( this.productId(2)==0 || productId2<=0 || this.productId(2)==productId2 ) &&
|
|
( this.productId(3)==0 || productId3<=0 || this.productId(3)==productId3 ) </pre>
|
|
* @param productId0 Byte 0 of the given product ID
|
|
* @param productId1 Byte 1 of the given product ID
|
|
* @param productId2 Byte 2 of the given product ID
|
|
* @param productId3 Byte 3 of the given product ID
|
|
* @return true if the given product ID is compatible and interface 1 is supported.
|
|
*/
|
public boolean compatible ( int productId0, int productId1, int productId2, int productId3 ) {
|
public boolean compatible ( int productId0, int productId1, int productId2, int productId3 ) {
|
return dev.valid() && dev.compatible ( productId0, productId1, productId2, productId3 ) && dev.interfaceVersion()==1;
|
return dev().valid() && dev().compatible ( productId0, productId1, productId2, productId3 ) && dev().interfaceVersion()==1;
|
}
|
}
|
|
|
// ******* checkValid **********************************************************
|
// ******* checkValid **********************************************************
|
|
/**
|
|
* Checks whether ZTEX descriptor 1 is available and interface 1 is supported.
|
|
* @throws InvalidFirmwareException if ZTEX descriptor 1 is not available or interface 1 is not supported.
|
|
*/
|
public void checkValid () throws InvalidFirmwareException {
|
public void checkValid () throws InvalidFirmwareException {
|
super.checkValid();
|
super.checkValid();
|
if ( dev.interfaceVersion() != 1 )
|
if ( dev().interfaceVersion() != 1 )
|
throw new InvalidFirmwareException(this, "Wrong interface: " + dev.interfaceVersion() + ", expected: 1" );
|
throw new InvalidFirmwareException(this, "Wrong interface: " + dev().interfaceVersion() + ", expected: 1" );
|
}
|
}
|
|
|
// ******* checkCapability *****************************************************
|
// ******* checkCapability *****************************************************
|
|
/**
|
|
* Checks whether ZTEX descriptor 1 is available and interface 1 and a given capability are supported.
|
|
* @param i byte index of the capability
|
|
* @param j bit index of the capability
|
|
* @throws InvalidFirmwareException if ZTEX descriptor 1 is not available or interface 1 is not supported.
|
|
* @throws CapabilityException if the given capability is not supported.
|
|
*/
|
public void checkCapability ( int i, int j ) throws InvalidFirmwareException, CapabilityException {
|
public void checkCapability ( int i, int j ) throws InvalidFirmwareException, CapabilityException {
|
checkValid();
|
checkValid();
|
if ( ! dev.interfaceCapabilities(i,j) ) {
|
if ( ! dev().interfaceCapabilities(i,j) ) {
|
int k = i*8 + j;
|
int k = i*8 + j;
|
if ( k>=0 && k<capabilityStrings.length )
|
if ( k>=0 && k<capabilityStrings.length )
|
throw new CapabilityException( this, ( k>=0 && k<=capabilityStrings.length ) ? capabilityStrings[k] : ("Capabilty " + i + "," + j) );
|
throw new CapabilityException( this, ( k>=0 && k<=capabilityStrings.length ) ? capabilityStrings[k] : ("Capabilty " + i + "," + j) );
|
}
|
}
|
}
|
}
|
|
|
// ******* checkCompatible *****************************************************
|
// ******* checkCompatible *****************************************************
|
|
/**
|
|
* Checks whether the given product ID is compatible to the device corresponding to this class and whether interface 1 is supported.
|
|
* See {@link #compatible(int,int,int,int)}.
|
|
* @param productId0 Byte 0 of the given product ID
|
|
* @param productId1 Byte 1 of the given product ID
|
|
* @param productId2 Byte 2 of the given product ID
|
|
* @param productId3 Byte 3 of the given product ID
|
|
* @throws InvalidFirmwareException if the given product ID is not compatible or interface 1 is not supported.
|
|
*/
|
public void checkCompatible ( int productId0, int productId1, int productId2, int productId3 ) throws InvalidFirmwareException {
|
public void checkCompatible ( int productId0, int productId1, int productId2, int productId3 ) throws InvalidFirmwareException {
|
checkValid();
|
checkValid();
|
if ( ! dev.compatible ( productId0, productId1, productId2, productId3 ) )
|
if ( ! dev().compatible ( productId0, productId1, productId2, productId3 ) )
|
throw new InvalidFirmwareException(this, "Incompatible Product ID");
|
throw new InvalidFirmwareException(this, "Incompatible Product ID");
|
}
|
}
|
|
|
// ******* getFpgaState ********************************************************
|
// ******* getFpgaState ********************************************************
|
private void getFpgaState () throws UsbException, InvalidFirmwareException, CapabilityException {
|
private void getFpgaState () throws UsbException, InvalidFirmwareException, CapabilityException {
|
| Line 108... |
Line 353... |
fpgaChecksum = buffer[1] & 0xff;
|
fpgaChecksum = buffer[1] & 0xff;
|
fpgaBytes = ((buffer[5] & 0xff)<<24) | ((buffer[4] & 0xff)<<16) | ((buffer[3] & 0xff)<<8) | (buffer[2] & 0xff);
|
fpgaBytes = ((buffer[5] & 0xff)<<24) | ((buffer[4] & 0xff)<<16) | ((buffer[3] & 0xff)<<8) | (buffer[2] & 0xff);
|
fpgaInitB = buffer[6] & 0xff;
|
fpgaInitB = buffer[6] & 0xff;
|
}
|
}
|
|
|
|
// ******* getFpgaState ********************************************************
|
|
/**
|
|
* Prints out the FPGA state.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if FPGA configuration is not supported by the firmware.
|
|
*/
|
|
public void printFpgaState () throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
getFpgaState();
|
|
System.out.println( "size=" + fpgaBytes + " ; checksum=" + fpgaChecksum + "; INIT_B_HIST=" + fpgaInitB +" (should be 222)" );
|
|
}
|
|
|
// ******* getFpgaConfiguration ************************************************
|
// ******* getFpgaConfiguration ************************************************
|
|
/**
|
|
* Returns true if the FPGA is configured.
|
|
* @return true if the FPGA is configured.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if FPGA configuration is not supported by the firmware.
|
|
*/
|
public boolean getFpgaConfiguration () throws UsbException, InvalidFirmwareException, CapabilityException {
|
public boolean getFpgaConfiguration () throws UsbException, InvalidFirmwareException, CapabilityException {
|
getFpgaState ();
|
getFpgaState ();
|
return fpgaConfigured;
|
return fpgaConfigured;
|
}
|
}
|
|
|
// ******* getFpgaConfigurationStr *********************************************
|
// ******* getFpgaConfigurationStr *********************************************
|
|
/**
|
|
* Returns a string that indicates the FPGA configuration status.
|
|
* @return a string that indicates the FPGA configuration status.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if FPGA configuration is not supported by the firmware.
|
|
*/
|
public String getFpgaConfigurationStr () throws UsbException, InvalidFirmwareException, CapabilityException {
|
public String getFpgaConfigurationStr () throws UsbException, InvalidFirmwareException, CapabilityException {
|
getFpgaState ();
|
getFpgaState ();
|
return fpgaConfigured ? "FPGA configured" : "FPGA unconfigured";
|
return fpgaConfigured ? "FPGA configured" : "FPGA unconfigured";
|
}
|
}
|
|
|
// ******* resetFGPA ***********************************************************
|
// ******* resetFGPA ***********************************************************
|
|
/**
|
|
* Resets the FPGA.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if FPGA configuration is not supported by the firmware.
|
|
*/
|
public void resetFpga () throws UsbException, InvalidFirmwareException, CapabilityException {
|
public void resetFpga () throws UsbException, InvalidFirmwareException, CapabilityException {
|
checkCapability(0,1);
|
checkCapability(0,1);
|
vendorCommand(0x31, "resetFpga" );
|
vendorCommand(0x31, "resetFpga" );
|
}
|
}
|
|
|
// ******* configureFpga *******************************************************
|
// ******* configureFpga *******************************************************
|
// returns configuration time in ms
|
// returns configuration time in ms
|
|
/**
|
|
* Upload a Bitstream to the FPGA.
|
|
* @param fwFileName The file name of the Bitstream. The file can be a regular file or a system resource (e.g. a file from the current jar archive).
|
|
* @param force If set to true existing configurations will be overwritten. (By default an {@link AlreadyConfiguredException} is thrown).
|
|
* @throws BitstreamReadException if an error occurred while attempting to read the Bitstream.
|
|
* @throws BitstreamUploadException if an error occurred while attempting to upload the Bitstream.
|
|
* @throws AlreadyConfiguredException if the FPGA is already configured.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if FPGA configuration is not supported by the firmware.
|
|
*/
|
public long configureFpga ( String fwFileName, boolean force ) throws BitstreamReadException, UsbException, BitstreamUploadException, AlreadyConfiguredException, InvalidFirmwareException, CapabilityException {
|
public long configureFpga ( String fwFileName, boolean force ) throws BitstreamReadException, UsbException, BitstreamUploadException, AlreadyConfiguredException, InvalidFirmwareException, CapabilityException {
|
final int transactionBytes = certainWorkarounds ? 256 : 2048;
|
final int transactionBytes = certainWorkarounds ? 256 : 2048;
|
long t0 = 0;
|
long t0 = 0;
|
|
|
checkCapability(0,1);
|
checkCapability(0,1);
|
|
|
if ( !force && getFpgaConfiguration() )
|
if ( !force && getFpgaConfiguration() )
|
throw new AlreadyConfiguredException();
|
throw new AlreadyConfiguredException();
|
|
|
// read the bitstream file
|
// read the Bitstream file
|
byte[][] buffer = new byte[4*1024*1024/transactionBytes][];
|
byte[][] buffer = new byte[4*1024*1024/transactionBytes][];
|
int size = 0;
|
int size = 0;
|
try {
|
try {
|
InputStream inputStream = JInputStream.getInputStream( fwFileName );
|
InputStream inputStream = JInputStream.getInputStream( fwFileName );
|
int j = transactionBytes;
|
int j = transactionBytes;
|
| Line 166... |
Line 454... |
throw new BitstreamReadException(e.getLocalizedMessage());
|
throw new BitstreamReadException(e.getLocalizedMessage());
|
}
|
}
|
if ( size < 64 || size % 64 == 0 )
|
if ( size < 64 || size % 64 == 0 )
|
throw new BitstreamReadException("Invalid file size: " + size );
|
throw new BitstreamReadException("Invalid file size: " + size );
|
|
|
// upload the bitstream file
|
// upload the Bitstream file
|
for ( int tries=10; tries>0; tries-- ) {
|
for ( int tries=10; tries>0; tries-- ) {
|
|
|
resetFpga();
|
resetFpga();
|
|
|
try {
|
try {
|
| Line 193... |
Line 481... |
// System.err.println("fpgaConfigred=" + fpgaConfigured + " fpgaBytes="+fpgaBytes + " ("+bs+") fpgaChecksum="+fpgaChecksum + " ("+cs+") fpgaInitB="+fpgaInitB );
|
// System.err.println("fpgaConfigred=" + fpgaConfigured + " fpgaBytes="+fpgaBytes + " ("+bs+") fpgaChecksum="+fpgaChecksum + " ("+cs+") fpgaInitB="+fpgaInitB );
|
if ( ! fpgaConfigured ) {
|
if ( ! fpgaConfigured ) {
|
throw new BitstreamUploadException( "FPGA configuration failed: DONE pin does not go high (size=" + fpgaBytes + " , " + (bs - fpgaBytes) + " bytes went lost; checksum="
|
throw new BitstreamUploadException( "FPGA configuration failed: DONE pin does not go high (size=" + fpgaBytes + " , " + (bs - fpgaBytes) + " bytes went lost; checksum="
|
+ fpgaChecksum + " , should be " + cs + "; INIT_B_HIST=" + fpgaInitB +", should be 222)" );
|
+ fpgaChecksum + " , should be " + cs + "; INIT_B_HIST=" + fpgaInitB +", should be 222)" );
|
}
|
}
|
|
// System.out.println( "FPGA configuration: size=" + fpgaBytes + " , " + (bs - fpgaBytes) + " bytes went lost; checksum=" + fpgaChecksum + " , should be " + cs + "; INIT_B_HIST=" + fpgaInitB +", should be 222" );
|
if ( fpgaInitB != 222 )
|
if ( fpgaInitB != 222 )
|
System.err.println ( "Warning: FPGA configuration may have failed: DONE pin has gone high but INIT_B states are wrong: " + fpgaInitB +", should be 222");
|
System.err.println ( "Warning: FPGA configuration may have failed: DONE pin has gone high but INIT_B states are wrong: " + fpgaInitB +", should be 222");
|
|
|
tries = 0;
|
tries = 0;
|
t0 += new Date().getTime();
|
t0 += new Date().getTime();
|
| Line 219... |
Line 508... |
return t0;
|
return t0;
|
}
|
}
|
|
|
// ******* eepromState *********************************************************
|
// ******* eepromState *********************************************************
|
// returns true if EEPROM is ready
|
// returns true if EEPROM is ready
|
|
/**
|
|
* Reads the current EEPROM status.
|
|
* This method also sets the varibles {@link #eepromBytes} and {@link #eepromChecksum}.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if EEPROM access is not supported by the firmware.
|
|
* @return true if EEPROM is ready.
|
|
*/
|
public boolean eepromState ( ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
public boolean eepromState ( ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
byte[] buf = new byte[4];
|
byte[] buf = new byte[4];
|
checkCapability(0,0);
|
checkCapability(0,0);
|
vendorRequest2(0x3A, "EEPROM State", 0, 0, buf, 4);
|
vendorRequest2(0x3A, "EEPROM State", 0, 0, buf, 4);
|
eepromBytes = (buf[0] & 255) | (buf[1] & 255)<<8;
|
eepromBytes = (buf[0] & 255) | (buf[1] & 255)<<8;
|
eepromChecksum = buf[2] & 255;
|
eepromChecksum = buf[2] & 255;
|
eepromReady = buf[3] == 0;
|
return buf[3] == 0;
|
return eepromReady;
|
|
}
|
}
|
|
|
// ******* eepromWrite *********************************************************
|
// ******* eepromWrite *********************************************************
|
|
/**
|
|
* Writes data to the EEPROM.
|
|
* @param addr The destination address of the EEPROM.
|
|
* @param buf The data.
|
|
* @param length The amount of bytes to be sent.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if EEPROM access is not supported by the firmware.
|
|
*/
|
public void eepromWrite ( int addr, byte[] buf, int length ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
public void eepromWrite ( int addr, byte[] buf, int length ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
checkCapability(0,0);
|
checkCapability(0,0);
|
vendorCommand2( 0x39, "EEPROM Write", addr, 0, buf, length );
|
vendorCommand2( 0x39, "EEPROM Write", addr, 0, buf, length );
|
|
try {
|
|
Thread.sleep( 10 );
|
|
}
|
|
catch ( InterruptedException e) {
|
|
}
|
}
|
}
|
|
|
// ******* eepromRead **********************************************************
|
// ******* eepromRead **********************************************************
|
|
/**
|
|
* Reads data from the EEPROM.
|
|
* @param addr The source address of the EEPROM.
|
|
* @param buf A buffer for the storage of the data.
|
|
* @param length The amount of bytes to be read.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if EEPROM access is not supported by the firmware.
|
|
*/
|
public void eepromRead ( int addr, byte[] buf, int length ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
public void eepromRead ( int addr, byte[] buf, int length ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
checkCapability(0,0);
|
checkCapability(0,0);
|
for ( int tries=4; tries>0; tries-- ) {
|
|
try {
|
|
vendorRequest2( 0x38, "EEPROM Read", addr, 0, buf, length ); // sometimes a little bit slow
|
vendorRequest2( 0x38, "EEPROM Read", addr, 0, buf, length ); // sometimes a little bit slow
|
tries = 0;
|
try {
|
}
|
Thread.sleep( 10 );
|
catch ( UsbException e ) {
|
|
if ( tries<=1 ) throw e;
|
|
}
|
}
|
|
catch ( InterruptedException e) {
|
}
|
}
|
}
|
}
|
|
|
// ******* eepromUpload ********************************************************
|
// ******* eepromUpload ********************************************************
|
// returns upload time in ms
|
// returns upload time in ms
|
|
/**
|
|
* Upload the firmware to the EEPROM.
|
|
* In order to start the uploaded firmware the device must be reset.
|
|
* @param ihxFileName The file name of the firmware image in ihx format. The file can be a regular file or a system resource (e.g. a file from the current jar archive).
|
|
* @param force Skips the compatibility check if true.
|
|
* @throws IncompatibleFirmwareException if the given firmware is not compatible to the installed one, see {@link #compatible(int,int,int,int)} (Upload can be enforced using the <tt>force</tt> parameter.)
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws CapabilityException if EEPROM access is not supported by the firmware.
|
|
* @throws FirmwareUploadException if an error occurred while attempting to upload the firmware.
|
|
*/
|
public long eepromUpload ( String ihxFileName, boolean force ) throws IncompatibleFirmwareException, FirmwareUploadException, InvalidFirmwareException, CapabilityException {
|
public long eepromUpload ( String ihxFileName, boolean force ) throws IncompatibleFirmwareException, FirmwareUploadException, InvalidFirmwareException, CapabilityException {
|
final int pagesMax = 256;
|
final int pagesMax = 256;
|
final int pageSize = 256;
|
final int pageSize = 256;
|
int pages = 0;
|
int pages = 0;
|
byte[][] buffer = new byte[pagesMax][];
|
byte[][] buffer = new byte[pagesMax][];
|
| Line 274... |
Line 600... |
}
|
}
|
// ihxFile.dataInfo(System.out);
|
// ihxFile.dataInfo(System.out);
|
// System.out.println(ihxFile);
|
// System.out.println(ihxFile);
|
|
|
// check for compatibility
|
// check for compatibility
|
if ( ! force && dev.valid() ) {
|
if ( ! force && dev().valid() ) {
|
if ( ihxFile.interfaceVersion() != 1 )
|
if ( ihxFile.interfaceVersion() != 1 )
|
throw new IncompatibleFirmwareException("Wrong interface version: Expected 1, got " + ihxFile.interfaceVersion() );
|
throw new IncompatibleFirmwareException("Wrong interface version: Expected 1, got " + ihxFile.interfaceVersion() );
|
|
|
if ( ! dev.compatible ( ihxFile.productId(0), ihxFile.productId(1), ihxFile.productId(2), ihxFile.productId(3) ) )
|
if ( ! dev().compatible ( ihxFile.productId(0), ihxFile.productId(1), ihxFile.productId(2), ihxFile.productId(3) ) )
|
throw new IncompatibleFirmwareException("Incompatible productId's: Current firmware: " + ZtexDevice1.byteArrayString(dev.productId())
|
throw new IncompatibleFirmwareException("Incompatible productId's: Current firmware: " + ZtexDevice1.byteArrayString(dev().productId())
|
+ " Ihx File: " + ZtexDevice1.byteArrayString(ihxFile.productId()) );
|
+ " Ihx File: " + ZtexDevice1.byteArrayString(ihxFile.productId()) );
|
}
|
}
|
|
|
Usb_Device_Descriptor dd = dev.dev().getDescriptor();
|
Usb_Device_Descriptor dd = dev().dev().getDescriptor();
|
int vid = dd.getIdVendor() & 65535;
|
int vid = dd.getIdVendor() & 65535;
|
int pid = dd.getIdProduct() & 65535;
|
int pid = dd.getIdProduct() & 65535;
|
|
|
buffer[0] = new byte[pageSize];
|
buffer[0] = new byte[pageSize];
|
buffer[0][0] = (byte) 0xc2;
|
buffer[0][0] = (byte) 0xc2;
|
| Line 342... |
Line 668... |
int cs = 0;
|
int cs = 0;
|
for (int j=0; j<k; j++ ) {
|
for (int j=0; j<k; j++ ) {
|
cs = ( cs + (buffer[i][j] & 255) ) & 255;
|
cs = ( cs + (buffer[i][j] & 255) ) & 255;
|
}
|
}
|
|
|
for ( int tries=4; tries>0; tries-- ) {
|
for ( int tries=3; tries>0; tries-- ) {
|
try {
|
try {
|
eepromWrite(i*pageSize, buffer[i], k);
|
eepromWrite(i*pageSize, buffer[i], k);
|
eepromState();
|
eepromState();
|
if ( eepromBytes!=k )
|
if ( eepromBytes!=k )
|
throw new FirmwareUploadException("Error writing data to EEPROM: Wrote " + eepromBytes + " bytes instead of " + k + " bytes" );
|
throw new FirmwareUploadException("Error writing data to EEPROM: Wrote " + eepromBytes + " bytes instead of " + k + " bytes" );
|
| Line 374... |
Line 700... |
return new Date().getTime() - t0;
|
return new Date().getTime() - t0;
|
}
|
}
|
|
|
|
|
// ******* eepromDisable ********************************************************
|
// ******* eepromDisable ********************************************************
|
|
/**
|
|
* Disables the firmware stored in the EEPROM.
|
|
* This is achived by writing a "0" to the address 0 of the EEPROM.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws CapabilityException if EEPROM access is not supported by the firmware.
|
|
* @throws FirmwareUploadException if an error occurred while attempting to disable the firmware.
|
|
*/
|
public void eepromDisable ( ) throws FirmwareUploadException, InvalidFirmwareException, CapabilityException {
|
public void eepromDisable ( ) throws FirmwareUploadException, InvalidFirmwareException, CapabilityException {
|
byte[] buf = { 0 };
|
byte[] buf = { 0 };
|
|
|
for ( int tries=4; tries>0; tries-- ) {
|
for ( int tries=3; tries>0; tries-- ) {
|
try {
|
try {
|
eepromWrite(0, buf, 1);
|
eepromWrite(0, buf, 1);
|
|
|
eepromRead(0, buf, 1);
|
eepromRead(0, buf, 1);
|
if ( buf[0] != 0 )
|
if ( buf[0] != 0 )
|
| Line 398... |
Line 731... |
}
|
}
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
|
// ******* flashStrError *******************************************************
|
|
/**
|
|
* Converts a given error code into a String.
|
|
* @param errNum The error code.
|
|
* @return an error message.
|
|
*/
|
|
public static String flashStrError ( int errNum ) {
|
|
switch ( errNum ) {
|
|
case FLASH_EC_NO_ERROR:
|
|
return "USB error: " + LibusbJava.usb_strerror();
|
|
case FLASH_EC_CMD_ERROR:
|
|
return "Command error";
|
|
case FLASH_EC_TIMEOUT:
|
|
return "Timeout error";
|
|
case FLASH_EC_BUSY:
|
|
return "Busy";
|
|
case FLASH_EC_PENDING:
|
|
return "Another operation is pending";
|
|
case FLASH_EC_READ_ERROR:
|
|
return "Read error";
|
|
case FLASH_EC_WRITE_ERROR:
|
|
return "Write error";
|
|
}
|
|
return "Error " + errNum;
|
|
}
|
|
|
|
/**
|
|
* Gets the last Flash error from the device.
|
|
* @return an error message.
|
|
*/
|
|
public String flashStrError ( ) {
|
|
try {
|
|
return flashStrError( getFlashEC() );
|
|
}
|
|
catch ( Exception e ) {
|
|
return "Unknown error (Error receiving errorcode: "+e.getLocalizedMessage() +")";
|
|
}
|
|
}
|
|
|
|
// ******* flashState **********************************************************
|
|
/**
|
|
* Reads the the Flash memory status and information.
|
|
* This method also sets the variables {@link #flashEnabled}, {@link #flashSectorSize} and {@link #flashSectors}.
|
|
* @return true if Flash memory is installed.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not supported by the firmware.
|
|
*/
|
|
public boolean flashState () throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
byte[] buf = new byte[8];
|
|
checkCapability(0,2);
|
|
|
|
// device may be busy due to initialization, we try it up to up to 4s
|
|
vendorRequest2(0x40, "Flash State", 0, 0, buf, 8);
|
|
flashEC = buf[7] & 255;
|
|
int tries=20;
|
|
while ( flashEC==FLASH_EC_BUSY && tries>0 )
|
|
{
|
|
try {
|
|
Thread.sleep( 200 );
|
|
}
|
|
catch ( InterruptedException e) {
|
|
}
|
|
tries-=1;
|
|
vendorRequest2(0x40, "Flash State", 0, 0, buf, 8);
|
|
flashEC = buf[7] & 255;
|
|
}
|
|
flashEnabled = buf[0] & 255;
|
|
flashSectorSize = flashEnabled == 1 ? ((buf[2] & 255) << 8) | (buf[1] & 255) : 0;
|
|
flashSectors = flashEnabled == 1 ? ((buf[6] & 255) << 24) | ((buf[5] & 255) << 16) | ((buf[4] & 255) << 8) | (buf[3] & 255) : 0;
|
|
return flashEnabled == 1;
|
|
}
|
|
|
|
// ******* getFlashEC **********************************************************
|
|
// reads the current error code
|
|
/**
|
|
* Gets the last Flash error from the device.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not supported by the firmware.
|
|
*/
|
|
public int getFlashEC () throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
byte[] buf = new byte[8];
|
|
checkCapability(0,2);
|
|
vendorRequest2(0x40, "Flash State", 0, 0, buf, 8);
|
|
flashEC = buf[7] & 255;
|
|
return flashEC;
|
|
}
|
|
|
|
// ******* flashReadSector ****************************************************
|
|
// read exactly one sector
|
|
/**
|
|
* Reads one sector from the Flash.
|
|
* @param sector The sector number to be read.
|
|
* @param buf A buffer for the storage of the data.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not possible.
|
|
*/
|
|
public void flashReadSector ( int sector, byte[] buf ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
checkCapability(0,2);
|
|
if ( ! flashEnabled() )
|
|
throw new CapabilityException(this, "No Flash memory installed or");
|
|
|
|
try {
|
|
vendorRequest2( 0x41, "Flash Read", sector, 0, buf, flashSectorSize );
|
|
}
|
|
catch ( UsbException e ) {
|
|
throw new UsbException( dev().dev(), "Flash Read: " + flashStrError() );
|
|
}
|
|
}
|
|
|
|
// ******* flashWriteSector ***************************************************
|
|
// write exactly one sector
|
|
/**
|
|
* Writes one sector to the Flash.
|
|
* @param sector The sector number to be written.
|
|
* @param buf The data.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not possible.
|
|
*/
|
|
public void flashWriteSector ( int sector, byte[] buf ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
checkCapability(0,2);
|
|
if ( ! flashEnabled() )
|
|
throw new CapabilityException(this, "No Flash memory installed or");
|
|
|
|
try {
|
|
vendorCommand2( 0x42, "Flash Write", sector, 0, buf, flashSectorSize );
|
|
}
|
|
catch ( UsbException e ) {
|
|
throw new UsbException( dev().dev(), "Flash Write: " + flashStrError() );
|
|
}
|
|
}
|
|
|
|
// ******* flashEnabled ********************************************************
|
|
// returns enabled / disabled state
|
|
/**
|
|
* Returns true if Flash memory is installed.
|
|
* @return true if Flash memory is installed.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not supported by the firmware.
|
|
*/
|
|
public boolean flashEnabled () throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
if ( flashEnabled < 0 ) // init variable
|
|
flashState();
|
|
return flashEnabled == 1;
|
|
}
|
|
|
|
// ******* flashSectorSize *****************************************************
|
|
// returns sector size of Flash memory, if available
|
|
/**
|
|
* Returns the sector size of the Flash memory or 0, if no flash memory is installed.
|
|
* If required, the sector size is determined form the device first.
|
|
* @return the sector size of the Flash memory.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not supported by the firmware.
|
|
*/
|
|
public int flashSectorSize () throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
if ( flashSectorSize < 0 ) // init variable
|
|
flashState();
|
|
return flashSectorSize;
|
|
}
|
|
|
|
// ******* flashSectors ********************************************************
|
|
// returns number of sectors of Flash memory, if available
|
|
/**
|
|
* Returns the number of sectors of the Flash memory or 0, if no Flash memory is installed.
|
|
* If required, the number of sectors is determined form the device first.
|
|
* @return the number of sectors of the Flash memory.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not supported by the firmware.
|
|
*/
|
|
public int flashSectors () throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
if ( flashSectors < 0 ) // init variable
|
|
flashState();
|
|
return flashSectors;
|
|
}
|
|
|
|
// ******* flashSize ***********************************************************
|
|
// returns size of Flash memory, if available
|
|
/**
|
|
* Returns the size of Flash memory or 0, if no Flash memory is installed.
|
|
* If required, the Flash size is determined form the device first.
|
|
* @return the size of Flash memory.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not supported by the firmware.
|
|
*/
|
|
public long flashSize () throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
return flashSectorSize() * flashSectors();
|
|
}
|
|
|
|
// ******* printMmcState *******************************************************
|
|
// returns true if Flash is available
|
|
/**
|
|
* Prints out some debug information about *SD/MMC Flash cards in SPI mode.<br>
|
|
* <b>Only use this method if such kind of Flash is installed.</b>
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not supported by the firmware.
|
|
*/
|
|
public boolean printMmcState ( ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
byte[] buf = new byte[22];
|
|
checkCapability(0,2);
|
|
vendorRequest2(0x43, "MMC State", 0, 0, buf, 22);
|
|
System.out.println("status=" + Integer.toBinaryString(256+(buf[0] & 255)).substring(1) + "." + Integer.toBinaryString(256+(buf[1] & 255)).substring(1) +
|
|
" lastCmd=" + buf[3] +
|
|
" lastCmdResponse=" + Integer.toBinaryString(256+(buf[4] & 255)).substring(1) +
|
|
" ec=" + buf[2] +
|
|
" BUSY=" + buf[21] +
|
|
" buf=" + (buf[5] & 255)+" "+(buf[6] & 255)+" "+(buf[7] & 255)+" "+(buf[8] & 255)+" "+(buf[9] & 255)+" "+(buf[10] & 255)+" "+(buf[11] & 255)); // +" "+(buf[12] & 255)+" "+(buf[13] & 255)+" "+(buf[14] & 255)+" "+(buf[15] & 255)+" "+(buf[16] & 255));
|
|
|
|
return flashEnabled == 1;
|
|
}
|
|
|
|
// ******* flashUploadBitstream ************************************************
|
|
/*
|
|
Returns configuration time in ms.
|
|
The format of the boot sector (sector 0 of the Flash memory) is
|
|
0..7
|
|
8..9 Number of sectors, or 0 is disabled
|
|
10..11 Number of bytes in the last sector, i.e. th total size of Bitstream is ((bs[8] | (bs[9]<<8) - 1) * flash_sector_size + ((bs[10] | (bs[11]<<8))
|
|
*/
|
|
/**
|
|
* Uploads a Bitstream to the Flash.
|
|
* This allows the firmware to load the Bitstream from Flash. Together with installation of the firmware in EEPROM
|
|
* it is possible to construct fully autonomous devices.
|
|
* <p>
|
|
* Information about the bitstream is stored in sector 0.
|
|
* This so called boot sector has the following format:
|
|
* <table bgcolor="#404040" cellspacing=1 cellpadding=4>
|
|
* <tr>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Bytes</b></td>
|
|
* <td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">0..7</td>
|
|
* <td bgcolor="#ffffff" valign="top">ID, must be "ZTEXBS",1,1</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">8..9</td>
|
|
* <td bgcolor="#ffffff" valign="top">The number of sectors used to store the Bitstream. 0 means no Bitstream.</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">10..11</td>
|
|
* <td bgcolor="#ffffff" valign="top">The number of bytes in the last sector.</td>
|
|
* </tr>
|
|
* <tr>
|
|
* <td bgcolor="#ffffff" valign="top">12..sectorSize-1</td>
|
|
* <td bgcolor="#ffffff" valign="top">This data is reserved for future use and preserved by this method.</td>
|
|
* </tr>
|
|
* </table>
|
|
* <p>
|
|
* The total size of the Bitstream is computed as ((bs[8] | (bs[9]<<8) - 1) * flash_sector_size + ((bs[10] | (bs[11]<<8))
|
|
* where bs[i] denotes byte i of the boot sector.
|
|
* <p>
|
|
* The first sector of the Bitstream is sector 1.
|
|
* @param fwFileName The file name of the Bitstream. The file can be a regular file or a system resource (e.g. a file from the current jar archive).
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not possible.
|
|
* @throws BitstreamReadException if an error occurred while attempting to read the Bitstream.
|
|
*/
|
|
public long flashUploadBitstream ( String fwFileName ) throws BitstreamReadException, UsbException, InvalidFirmwareException, CapabilityException {
|
|
checkCapability(0,2);
|
|
if ( ! flashEnabled() )
|
|
throw new CapabilityException(this, "No Flash memory installed or");
|
|
|
|
// read the Bitstream file
|
|
byte[][] buffer = new byte[2048][];
|
|
int i,j;
|
|
try {
|
|
InputStream inputStream = JInputStream.getInputStream( fwFileName );
|
|
j = flashSectorSize;
|
|
for ( i=0; i<buffer.length && j==flashSectorSize; i++ ) {
|
|
buffer[i] = new byte[flashSectorSize];
|
|
j = inputStream.read( buffer[i] );
|
|
if ( j < 0 )
|
|
j = 0;
|
|
}
|
|
|
|
try {
|
|
inputStream.close();
|
|
}
|
|
catch ( Exception e ) {
|
|
System.err.println( "Warning: Error closing file " + fwFileName + ": " + e.getLocalizedMessage() );
|
|
}
|
|
}
|
|
catch (IOException e) {
|
|
throw new BitstreamReadException(e.getLocalizedMessage());
|
|
}
|
|
|
|
// upload the Bitstream file
|
|
byte[] sector = new byte[flashSectorSize];
|
|
byte[] ID = new String("ZTEXBS").getBytes();
|
|
|
|
flashReadSector(0,sector); // read the boot sector (only the first 16 bytes are overwritten)
|
|
for (int k=0; k<6; k++)
|
|
sector[k]=ID[k];
|
|
sector[6] = 1;
|
|
sector[7] = 1;
|
|
sector[8] = (byte) (i & 255);
|
|
sector[9] = (byte) ((i>>8) & 255);
|
|
sector[10] = (byte) (j & 255);
|
|
sector[11] = (byte) ((j>>8) & 255);
|
|
long t0 = new Date().getTime();
|
|
flashWriteSector(0,sector); // write the boot sector
|
|
for (int k=0; k<i; k++)
|
|
flashWriteSector(k+1,buffer[k]); // write the Bitstream sectors
|
|
|
|
return new Date().getTime() - t0;
|
|
}
|
|
|
|
// ******* flashResetBitstream *************************************************
|
|
// Clears a Bitstream from the Flash.
|
|
/**
|
|
* Clears a Bitstream from the Flash.
|
|
* This is achieved by writing 0 to bytes 8..9 of the boot sector, see {@link #flashUploadBitstream(String)}.
|
|
* If no boot sector is installed the method returns without any write action.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not possible.
|
|
*/
|
|
public void flashResetBitstream ( ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
checkCapability(0,2);
|
|
if ( ! flashEnabled() )
|
|
throw new CapabilityException(this, "No Flash memory installed or");
|
|
byte[] sector = new byte[flashSectorSize];
|
|
byte[] ID = new String("ZTEXBS").getBytes();
|
|
|
|
flashReadSector(0,sector); // read the boot sector
|
|
for (int k=0; k<6; k++)
|
|
if ( sector[k] != ID[k] )
|
|
return;
|
|
if (sector[6]!=1 || sector[7]!=1 )
|
|
return;
|
|
sector[8] = 0;
|
|
sector[9] = 0;
|
|
flashWriteSector(0,sector); // write the boot sector
|
|
}
|
|
|
|
// ******* flashFirstFreeSector ************************************************
|
|
// Returns the first free sector of the Flash memory, i.e. the first sector behind the Bitstream
|
|
/**
|
|
* Returns the first free sector of the Flash memory.
|
|
* This is the first sector behind the Bitstream, or 0 if no boot sector is installed (or 1 if a boot sector but no Bitstream is installed).
|
|
* @return the first free sector of the Flash memory.
|
|
* @throws InvalidFirmwareException if interface 1 is not supported.
|
|
* @throws UsbException if a communication error occurs.
|
|
* @throws CapabilityException if Flash memory access is not possible.
|
|
*/
|
|
public int flashFirstFreeSector ( ) throws UsbException, InvalidFirmwareException, CapabilityException {
|
|
checkCapability(0,2);
|
|
if ( ! flashEnabled() )
|
|
throw new CapabilityException(this, "No Flash memory installed or");
|
|
|
|
byte[] sector = new byte[flashSectorSize];
|
|
byte[] ID = new String("ZTEXBS").getBytes();
|
|
|
|
flashReadSector(0,sector); // read the boot sector
|
|
for (int k=0; k<6; k++)
|
|
if ( sector[k] != ID[k] )
|
|
return 0;
|
|
if (sector[6]!=1 || sector[7]!=1 )
|
|
return 0;
|
|
return (sector[8] & 255) + ((sector[9] & 255) << 8) + 1;
|
|
}
|
|
|
// ******* toString ************************************************************
|
// ******* toString ************************************************************
|
|
/**
|
|
* Returns a lot of useful information about the corresponding device.
|
|
* @return a lot of useful information about the corresponding device.
|
|
*/
|
public String toString () {
|
public String toString () {
|
String str = dev.toString();
|
String str = dev().toString();
|
try {
|
try {
|
str += "\n " + getFpgaConfigurationStr();
|
str += "\n " + getFpgaConfigurationStr();
|
}
|
}
|
catch ( Exception e ) {
|
catch ( Exception e ) {
|
}
|
}
|
return str;
|
return str;
|
}
|
}
|
|
|
// ******* capabilityInfo ******************************************************
|
// ******* capabilityInfo ******************************************************
|
|
/**
|
|
* Creates a String with capability information.
|
|
* @param pf A separator between the single capabilities, e.g. ", "
|
|
* @return a string of the supported capabilities.
|
|
*/
|
public String capabilityInfo ( String pf ) {
|
public String capabilityInfo ( String pf ) {
|
String str = "";
|
String str = "";
|
for ( int i=0; i<6; i++ )
|
for ( int i=0; i<6; i++ )
|
for (int j=0; j<8; j++ )
|
for (int j=0; j<8; j++ )
|
if ( dev.interfaceCapabilities(i,j) ) {
|
if ( dev().interfaceCapabilities(i,j) ) {
|
if ( ! str.equals("") )
|
if ( ! str.equals("") )
|
str+="\n";
|
str+=pf;
|
if (i*8+j < capabilityStrings.length)
|
if (i*8+j < capabilityStrings.length)
|
str+=pf+capabilityStrings[i*8+j];
|
str+=capabilityStrings[i*8+j];
|
else
|
else
|
str+=pf+i+"."+j;
|
str+=i+"."+j;
|
}
|
}
|
return str;
|
return str;
|
}
|
}
|
}
|
}
|
|
|
