Subversion Repositories usb_fpga_1_11

/*!

/*!

   http://www.ztex.de

   http://www.ztex.de

   This program is free software; you can redistribute it and/or modify

   This program is free software; you can redistribute it and/or modify

   it under the terms of the GNU General Public License version 3 as

   it under the terms of the GNU General Public License version 3 as

   published by the Free Software Foundation.

   published by the Free Software Foundation.

                0        1:enabled, 0:disabled

                0        1:enabled, 0:disabled

                1-2     Sector size

                1-2     Sector size

                3-6     Number of sectors

                3-6     Number of sectors

                7       Error code

                7       Error code

        VR 0x41 : read from Flash

        VR 0x41 : read from Flash

    0.3  : Debug helper support

    0.3  : Debug helper support

        VR 0x28 : read debug data

        VR 0x28 : read debug data

            Returns:

            Returns:

                Offs    Description

                Offs    Description

                0-1     number of messages

                0-1     number of messages

                2       stack size in messages

                2       stack size in messages

                3       message size in bytes

                3       message size in bytes

                >=4     message stack

                >=4     message stack

*/

*/

package ztex;

package ztex;

import java.io.*;

import java.io.*;

import java.util.*;

import java.util.*;

  *                 <td bgcolor="#ffffff" valign="top">2-5</td>

  *                 <td bgcolor="#ffffff" valign="top">2-5</td>

  *                 <td bgcolor="#ffffff" valign="top">Number of bytes transferred.</td>

  *                 <td bgcolor="#ffffff" valign="top">Number of bytes transferred.</td>

  *               </tr>

  *               </tr>

  *               <tr>

  *               <tr>

  *                 <td bgcolor="#ffffff" valign="top">6</td>

  *                 <td bgcolor="#ffffff" valign="top">6</td>

  *               </tr>

  *               </tr>

  *             </table>

  *             </table>

  *           </td>

  *           </td>

  *         </tr>

  *         </tr>

  *         <tr>

  *         <tr>

  *           </td>

  *           </td>

  *         </tr>

  *         </tr>

  *       </table>

  *       </table>

  *     </td>

  *     </td>

  *   </tr>

  *   </tr>

  * </table>

  * </table>

  * @see ZtexDevice1

  * @see ZtexDevice1

  * @see Ztex1

  * @see Ztex1

  */

  */

public class Ztex1v1 extends Ztex1 {

public class Ztex1v1 extends Ztex1 {

    /** * Capability index for EEPROM support. */

    /** * Capability index for EEPROM support. */

    public static final int CAPABILITY_EEPROM = 0;

    public static final int CAPABILITY_EEPROM = 0;

    /** * Capability index for FPGA configuration support. */

    /** * Capability index for FPGA configuration support. */

    public static final int CAPABILITY_FPGA = 1;

    public static final int CAPABILITY_FPGA = 1;

    public static final int CAPABILITY_FLASH = 2;

    public static final int CAPABILITY_FLASH = 2;

    /** * Capability index for DEBUG helper support. */

    /** * Capability index for DEBUG helper support. */

    public static final int CAPABILITY_DEBUG = 3;

    public static final int CAPABILITY_DEBUG = 3;

    /** * Capability index for AVR XMEGA support. */

    /** * Capability index for AVR XMEGA support. */

    public static final int CAPABILITY_XMEGA = 4;

    public static final int CAPABILITY_XMEGA = 4;

    /** * The names of the capabilities */

    /** * 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",

        "Flash memory support",

        "Debug helper",

        "Debug helper",

    };

    };

    private boolean fpgaConfigured = false;

    private boolean fpgaConfigured = false;

    private int fpgaChecksum = 0;

    private int fpgaChecksum = 0;

    private int fpgaBytes = 0;

    private int fpgaBytes = 0;

    public static final int FLASH_EC_PENDING = 4;

    public static final int FLASH_EC_PENDING = 4;

    /** * Signals an error while attempting to read from Flash. */

    /** * Signals an error while attempting to read from Flash. */

    public static final int FLASH_EC_READ_ERROR = 5;

    public static final int FLASH_EC_READ_ERROR = 5;

    /** * Signals an error while attempting to write to Flash. */

    /** * Signals an error while attempting to write to Flash. */

    public static final int FLASH_EC_WRITE_ERROR = 6;

    public static final int FLASH_EC_WRITE_ERROR = 6;

    public static final int FLASH_EC_NOTSUPPORTED = 7;

    public static final int FLASH_EC_NOTSUPPORTED = 7;

    private int debugStackSize = -1;

    private int debugStackSize = -1;

    private int debugMsgSize = -1;

    private int debugMsgSize = -1;

    private int debugLastMsg = 0;

    private int debugLastMsg = 0;

    public int debugNewMessages = 0;

    public int debugNewMessages = 0;

// ******* Ztex1v1 *************************************************************

// ******* Ztex1v1 *************************************************************

/**

/**

  * Constructs an instance from a given device.

  * Constructs an instance from a given device.

  * @param pDev The given device.

  * @param pDev The given device.

  * @throws UsbException if an communication error occurred.

  * @throws UsbException if an communication error occurred.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws UsbException if a communication error occurs.

  * @throws UsbException if a communication error occurs.

  * @throws CapabilityException if FPGA configuration is not supported by the firmware.

  * @throws CapabilityException if FPGA configuration is not supported by the firmware.

  */

  */

    public void printFpgaState () throws UsbException, InvalidFirmwareException, CapabilityException {

    public void printFpgaState () throws UsbException, InvalidFirmwareException, CapabilityException {

        getFpgaState();

        getFpgaState();

    }

    }

// ******* getFpgaConfiguration ************************************************

// ******* getFpgaConfiguration ************************************************

/**

/**

  * Returns true if the FPGA is configured.

  * Returns true if the FPGA is configured.

                                 ((b &   1) << 7) );

                                 ((b &   1) << 7) );

            k++;

            k++;

        }

        }

    }

    }

//  returns configuration time in ms

//  returns configuration time in ms

/**

/**

  * @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 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).

  * @param force If set to true existing configurations will be overwritten. (By default an {@link AlreadyConfiguredException} is thrown).

  * @param bs 0: disable bit swapping, 1: enable bit swapping, all other values: automatic detection of bit order.

  * @param bs 0: disable bit swapping, 1: enable bit swapping, all other values: automatic detection of bit order.

  * @throws BitstreamReadException if an error occurred while attempting to read the Bitstream.

  * @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 BitstreamUploadException if an error occurred while attempting to upload the Bitstream.

  * @throws AlreadyConfiguredException if the FPGA is already configured.

  * @throws AlreadyConfiguredException if the FPGA is already configured.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws UsbException if a communication error occurs.

  * @throws UsbException if a communication error occurs.

  * @throws CapabilityException if FPGA configuration is not supported by the firmware.

  * @throws CapabilityException if FPGA configuration is not supported by the firmware.

  */

  */

        final int transactionBytes = certainWorkarounds ? 256 : 2048;

        final int transactionBytes = certainWorkarounds ? 256 : 2048;

        long t0 = 0;

        long t0 = 0;

        checkCapability(CAPABILITY_FPGA);

        checkCapability(CAPABILITY_FPGA);

        try {

        try {

            InputStream inputStream = JInputStream.getInputStream( fwFileName );

            InputStream inputStream = JInputStream.getInputStream( fwFileName );

            int j = transactionBytes;

            int j = transactionBytes;

            for ( int i=0; i<buffer.length && j==transactionBytes; i++ ) {

            for ( int i=0; i<buffer.length && j==transactionBytes; i++ ) {

                buffer[i] = new byte[transactionBytes];

                buffer[i] = new byte[transactionBytes];

                    j = 0;

                    j = 0;

                if ( j < transactionBytes && j % 64 == 0 )       // ensures size % 64 != 0

                if ( j < transactionBytes && j % 64 == 0 )       // ensures size % 64 != 0

                    j+=1;

                    j+=1;

                size += j;

                size += j;

            }

            }

                getFpgaState();

                getFpgaState();

//              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="

                }

                }

                tries = 0;

                tries = 0;

                t0 += new Date().getTime();

                t0 += new Date().getTime();

            }

            }

        }

        }

        return t0;

        return t0;

    }

    }

// ******* eepromState *********************************************************

// ******* eepromState *********************************************************

// returns true if EEPROM is ready

// returns true if EEPROM is ready

/**

/**

  * Reads the current EEPROM status.

  * Reads the current EEPROM status.

  * @throws UsbException if a communication error occurs.

  * @throws UsbException if a communication error occurs.

  * @throws CapabilityException if EEPROM access is not supported by the firmware.

  * @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(CAPABILITY_EEPROM);

        checkCapability(CAPABILITY_EEPROM);

        vendorCommand2( 0x39, "EEPROM Write", addr, 0, buf, length );

        vendorCommand2( 0x39, "EEPROM Write", addr, 0, buf, length );

        try {

        try {

            Thread.sleep( 10 );

            Thread.sleep( 10 );

        }

        }

        catch ( InterruptedException e) {

        catch ( InterruptedException e) {

        }

        }

// ******* eepromUpload ********************************************************

// ******* eepromUpload ********************************************************

//  returns upload time in ms

//  returns upload time in ms

/**

/**

  * Upload the firmware to the EEPROM.

  * Upload the firmware to the EEPROM.

  * In order to start the uploaded firmware the device must be reset.

  * In order to start the uploaded firmware the device must be reset.

  * @param force Skips the compatibility check if true.

  * @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 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 InvalidFirmwareException if interface 1 is not supported.

  * @throws CapabilityException if EEPROM access is not supported by the firmware.

  * @throws CapabilityException if EEPROM access is not supported by the firmware.

  * @throws FirmwareUploadException if an error occurred while attempting to upload the firmware.

  * @throws FirmwareUploadException if an error occurred while attempting to upload the firmware.

  */

  */

        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][];

        checkCapability(CAPABILITY_EEPROM);

        checkCapability(CAPABILITY_EEPROM);

//      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() ) {

        int ptr = 8, i = 0;

        int ptr = 8, i = 0;

        while ( i < ihxFile.ihxData.length ) {

        while ( i < ihxFile.ihxData.length ) {

            if ( ihxFile.ihxData[i]>=0 && ihxFile.ihxData[i]<256 ) {                     // new data block

            if ( ihxFile.ihxData[i]>=0 && ihxFile.ihxData[i]<256 ) {                     // new data block

                int j = 1;

                int j = 1;

                    j++;

                    j++;

                    buffer[k] = new byte[pageSize];

                    buffer[k] = new byte[pageSize];

                buffer[(ptr+0)/pageSize][(ptr+0) % pageSize] = (byte) ((j >> 8) & 255);

                buffer[(ptr+0)/pageSize][(ptr+0) % pageSize] = (byte) ((j >> 8) & 255);

                buffer[(ptr+1)/pageSize][(ptr+1) % pageSize] = (byte) (j & 255);                // length

                buffer[(ptr+1)/pageSize][(ptr+1) % pageSize] = (byte) (j & 255);                // length

                buffer[(ptr+2)/pageSize][(ptr+2) % pageSize] = (byte) ((i >> 8) & 255);

                buffer[(ptr+2)/pageSize][(ptr+2) % pageSize] = (byte) ((i >> 8) & 255);

        }

        }

        return new Date().getTime() - t0;

        return new Date().getTime() - t0;

    }

    }

// ******* eepromDisable ********************************************************

// ******* eepromDisable ********************************************************

/**

/**

  * Disables the firmware stored in the EEPROM.

  * Disables the firmware stored in the EEPROM.

  * This is achived by writing a "0" to the address 0 of the EEPROM.

  * This is achived by writing a "0" to the address 0 of the EEPROM.

    }

    }

// ******* flashState **********************************************************

// ******* flashState **********************************************************

/**

/**

  * Reads the the Flash memory status and information.

  * Reads the the Flash memory status and information.

  * @return true if Flash memory is installed.

  * @return true if Flash memory is installed.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws UsbException if a communication error occurs.

  * @throws UsbException if a communication error occurs.

  * @throws CapabilityException if Flash memory access is not supported by the firmware.

  * @throws CapabilityException if Flash memory access is not supported by the firmware.

  */

  */

  * @param sector The sector number to be read.

  * @param sector The sector number to be read.

  * @param buf A buffer for the storage of the data.

  * @param buf A buffer for the storage of the data.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws UsbException if a communication error occurs.

  * @throws UsbException if a communication error occurs.

  * @throws CapabilityException if Flash memory access is not possible.

  * @throws CapabilityException if Flash memory access is not possible.

  */

  */

        checkCapability(CAPABILITY_FLASH);

        checkCapability(CAPABILITY_FLASH);

        if ( ! flashEnabled() )

        if ( ! flashEnabled() )

            throw new CapabilityException(this, "No Flash memory installed or");

            throw new CapabilityException(this, "No Flash memory installed or");

        try {

        try {

        catch ( UsbException e ) {

        catch ( UsbException e ) {

            throw new UsbException( dev().dev(), "Flash Read: " + flashStrError() );

            throw new UsbException( dev().dev(), "Flash Read: " + flashStrError() );

        }

        }

    }

    }

// ******* flashWriteSector ***************************************************

// ******* flashWriteSector ***************************************************

// write exactly one sector

// write exactly one sector

/**

/**

  * Writes one sector to the Flash.

  * Writes one sector to the Flash.

  * @param sector The sector number to be written.

  * @param sector The sector number to be written.

  * @param buf The data.

  * @param buf The data.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws InvalidFirmwareException if interface 1 is not supported.

  * @throws UsbException if a communication error occurs.

  * @throws UsbException if a communication error occurs.

  * @throws CapabilityException if Flash memory access is not possible.

  * @throws CapabilityException if Flash memory access is not possible.

  */

  */

        checkCapability(CAPABILITY_FLASH);

        checkCapability(CAPABILITY_FLASH);

        if ( ! flashEnabled() )

        if ( ! flashEnabled() )

            throw new CapabilityException(this, "No Flash memory installed or");

            throw new CapabilityException(this, "No Flash memory installed or");

        try {

        try {

        catch ( UsbException e ) {

        catch ( UsbException e ) {

            throw new UsbException( dev().dev(), "Flash Write: " + flashStrError() );

            throw new UsbException( dev().dev(), "Flash Write: " + flashStrError() );

        }

        }

    }

    }

// ******* flashEnabled ********************************************************

// ******* flashEnabled ********************************************************

// returns enabled / disabled state 

// returns enabled / disabled state 

/**

/**

  * Returns true if Flash memory is installed.

  * Returns true if Flash memory is installed.

  * @return true if Flash memory is installed.

  * @return true if Flash memory is installed.

  * @throws UsbException if a communication error occurs.

  * @throws UsbException if a communication error occurs.

  * @throws CapabilityException if Flash memory access is not possible.

  * @throws CapabilityException if Flash memory access is not possible.

  * @throws BitstreamReadException if an error occurred while attempting to read the Bitstream.

  * @throws BitstreamReadException if an error occurred while attempting to read the Bitstream.

  */

  */

    public long flashUploadBitstream ( String fwFileName, int bs ) throws BitstreamReadException, UsbException, InvalidFirmwareException, CapabilityException {

    public long flashUploadBitstream ( String fwFileName, int bs ) throws BitstreamReadException, UsbException, InvalidFirmwareException, CapabilityException {

        checkCapability(CAPABILITY_FPGA);

        checkCapability(CAPABILITY_FPGA);

        checkCapability(CAPABILITY_FLASH);

        checkCapability(CAPABILITY_FLASH);

        if ( ! flashEnabled() )

        if ( ! flashEnabled() )

            throw new CapabilityException(this, "No Flash memory installed or");

            throw new CapabilityException(this, "No Flash memory installed or");

        getFpgaState();

        getFpgaState();

// read the Bitstream file      

// read the Bitstream file      

        byte[][] buffer = new byte[32768][];

        byte[][] buffer = new byte[32768][];

        try {

        try {

            InputStream inputStream = JInputStream.getInputStream( fwFileName );

            InputStream inputStream = JInputStream.getInputStream( fwFileName );

                    j = 0;

                    j = 0;

            }

            }

            try {

            try {