Release history Readme file for SuperSequencer Evaluation software

Note: This was previously the ADM106x evaluation software, but as support for the ADM116x family has been added it has been renamed the SuperSequencer Evaluation software.

Important Notice: I2C Interface Cables Device Drivers Requirements
The evaluation software supports the following USB to I2C interface cables:
•	USB-SDP-CABLEZ
•	USB-SMBUS-CABLEZ
•	CABLE-SMBUS-3PINZ (See note below)

The ADMxxxx Run-Time installs the necessary devices drivers to support these interfaces on the PC for use with the ADI evaluation tools.  These devices drivers support the Microsoft Windows XP, Vista, and 7 versions of the operating system.

If you have previously used the USB-SMBUS-CABLEZ or USB-5PSMBUS-CABLEZ with one of the following versions, or previous versions of the evaluation software, then you must also remove an older version of the device driver for these interface cables.
•	ADM106x Configuration Tool v4.0.6
•	ADM106x prog106x command line Tool v.1.0.2
•	ADM1175-8/91-92 Configuration Tool v 3.0.1

Refer to the document 'Updating USB-IIC Dongle Driver' in the Common folder of the Analog Devices entry in the Start menu for more details.

The CABLE-SMBUS-3PINZ and CABLE-SMBUS-5PINZ are Parallel port to IIC converter dongles.  These are only supported on Windows XP, due to changes in the Windows Driver architecture, it is not possible to provide support for these on any version of Windows Vista or Windows 7.  

Note: While these cables are currently supported by software, users are strongly recommended to replace them with one the USB based interfaces for reliability and robustness reasons.

Minimum system requirements
Windows 2000
500 MHz Processor
80 Meg free disc space
256Mb RAM

Minimum viewing resolution
800 x 600 High colour (16 bit)

ADM106x Software history

2.0.1 - First released version
Created November 3rd 2004
************************
1. MARGINING Window.
   Improvements - Margining window includes a calculator and test window.

Version 2.0.6
Created January 3rd 2005
************************

1. ADM106x
   Improvements - Included support for ADM1068/69 Old and new bond out

Version 3.0.1
Created January 25th 2005
*************************

1. ADM106x Software
   Fixed the sequencing engine restart problem - Bit0 of SECTRL register was getting set when 
   downloading to EEPROM.

2. "Recall Off-Line Settings From File" 
   Improvements - Better reporting when recalling files.

3. "Save Settings To File"
   Improvements - All checksum data locations are now labelled in the file.

4. OUTPUTS Window
   Bug fix - Labelling Bug in the "Pull up supply" dropdown box when configuring 
   ADM1068/69

5. INPUTS Window
   Bug fix - When configuring an ADM1068/69 VX4 was set to digital mode 
   regardless of what was in the configuration register.

6. REGISTER ACCESS Window
   Bug fix - Register reporting labels were incorrect When configuring an 
   ADM1068/69. All register labels are now correct.

7. MARGINING Window.
   Bug fix - No reporting of DAC voltages when entering the window.

8. MARGINING Window.
   Improvements - Full control of DACs independent of the calculator window.

9. MARGINING Window.
   Improvements - All data from the window can be saved and recalled from file.

10.ADM106x Start Up
   Improvements - Inclusion of multi device select options 

Version 3.0.2
Created March 31st 2005
***********************

1. "Save Settings To File" and " Save Off-Line Settings To File"
   Bug fix - Contents of register PDEN1 not saved to file. * Checksum errors may occur when  
   recalling pre version 3.0.2 text files.

2. "Recall Settings From File" 
   Bug fix - PDEN values overwritten when file is recalled.

3. REGISTER ACCESS Window
   Bug fix - When configuring an ADM1068/69 the register access window only displayed
   values for device address 9E.

4. ADM106x Software
   Improvements - Reduced overall CPU usage.

5. SEQUENCING ENGINE Window
   Improvements - Increased sequencing engine update speed.

6. SEQUENCING ENGINE Window
   Improvements - Sequencing Engine program is able to be expanded to display a
   greater number of states. This is a read only function and cannot be edited.
 
7. SEQUENCING ENGINE Window
   Bug fix - Pasting data into state 63 did not work.

8. ADM106x Start Up
   Improvements - Better reporting when recalling state and pin names from last saved session.

9. ADM106x Start Up
   Improvements - Enhanced multi device select options 

10.ADM106x Start Up
   Improvements - Better reporting on Silicon version and ADM1068/69 bond out status

11.WARNINGS Window
   Bug - VP3 Input range incorrect.

12."Save Configuration Version To EEPROM"
   Improvements - 'Do not show again' may be set in the main window and re-enabled in the main
   menu. 

13."Save Configuration Version To EEPROM"
   Improvements - This function can now be used in off line mode. It is launched when a save to 
   file is initiated.

14.ADM106x software
   Device search can be initiated on-line or off-line.

15.SEQUENCING ENGINE Window
   Improvements - Sequencing engine window includes Sequence Engine debug tool.

16.INPUTS Window
   Bug fix - Data was not retained when setting up of the digital registers offline. 

Version 3.0.3 to 3.0.5 NOT RELEASED
***********************************

Version 3.0.6
Created March 31st 2006
***********************

1. DEBUG TOOL Window
   Bug fix - Debug tool could not differentiate between digital input and analog input.

2. DEBUG TOOL Window
   Bug fix - Unable to Jump state when SMBus Jump was used as part of the Sequence.

3. TOP LEVEL Window
   Information on recommended pull-up resistors when SCL or SDA button is pressed

4. INPUTS Window
   Bug fix - Current sink symbol gave the impression that data had changed when switching between inputs.

5. OUTPUTS Window
   Bug fix - some instability with the pull-down strength selection when switching between windows.

6. TOP LEVEL Window
   Improvements - Added an additional display window showing Intel hex master checksum.

7. Margining Window.
   Bug fix - AUX1 and AUX 2 were not included in the drop down list for "Selected input".

8. Margining Window
   Bug fix - Potential divide data for VX1-5 and AUX 1-2 not saved to file.

9. Margining Window.
   Bug fix - Instability on DAC 1 when using the test window.

10.ADM106x Software
   Improvements - Ability to switch between multiple devices on the bus without restarting the SE.

11. ADM106x Software
   Improvements - Added the ability to program multiple devices using a daisy chain method.

12. "Save Settings To File" 
   Bug fix - Checksum error occurred when the line checksum was equal to x00h because A 16 bit value
   was being used as the line checksum instead of an 8 Bit value.  

13. SEQUENCING ENGINE Window
   Bug fix - In multi device mode, the State names were not saved when insert state was used.

14. SEQUENCING ENGINE Window
   Bug fix - In multi device mode, the SE data was not saved when switching between parts.

15. MARGINING Window
   Bug fix - The data for the potential divide was recalled when asked if the operator wished to recall Pin names, 
   State names and margining data on start up.

16. REGISTER ACCESS Window
   Bug fix - The UV and OV fault status were reversed.

17. MARGINING Window
   Bug fix - The 'DAC on' button and the Target margining data would be difficult to set when more than one channel 
   was margining. 

18. SEQUENCING ENGINE Window
   Improvements - Added a PDO zoom window which is launched using the blue button labelled 'Output’ on the program 
   editor.

19. OUTPUTS Window
   Bug fix - Changed 'Open Collector' to 'Open Drain' in the drop down box 

20. MARGINING Window
   Bug fix - When recalling a text file Pin names and state names were not recalled into the SE window. 

21. MARGINING Window
   Improvements - Increased the resistor input field to two decimal places to allow the input values for high 
   accuracy resistors. 

22. MARGINING Window
   Bug - The offline DAC configuration using an ADM1069 was not working correctly.

23. READBACK Window
   Improvements - The readback window now includes a data logger to file.(Excel or text)

24. INPUTS Window
   Improvements - Label change of the VX digital pins from 'Digital Fault Detector' to 'Digital Inputs'

25. SEQUENCING ENGINE Window 
   Improvements - The SE window now has a display to show what state the SE is currently in.

Version 3.0.7
Created May 17th 2006
*********************

1. SEQUENCING ENGINE Window 
   Bug - When switching between multiple parts the Sequence Engine window did not upload the correct data into the window.
   Also occurred when recalling files.

Version 4.0.0
Created May 1st 2007
********************

Bug Fixes
==========
1. Installation
   - Able to manage license agreement on non-Administrator accounts.

2. Pin Names Window
   - No Longer possible to 'tab' to hidden pin names text entry fields.
   - Configuration version numbers that contain leading zeros now display correctly on the screen. Leading zeros have always been stored correctly in       EEPROM, only the display in software was affected.

3. Margining Window
   - Many changes to the target value limiting code used to control the DAC output to ensure the correct range is available.
   - Incorrect mapping of ADC's when using an ADM1069 has been fixed.

4. Log Files
   - Extra lines between data points have been removed.
   - User is now warned if the file they are trying to log to can not be opened for writing.

5. Register Access Window
   - Numerous cosmetic fixes to prevent inadvertent text entry, and register bit view update issues.
   - Fixed the name of the PS1VOTH register, changed a zero to an 'O'.
   - Labelling was incorrect for status registers.

6. Sequence Engine Window
   - When deleting a state a modified dialog window is used to prevent the window being too large for the screen if there is a state that references or is       referenced by a large number of other states.
   - No longer possible to select the '-------' menu option in the Sequence state definition.
   - Additional bounds checking on the Sequence state list to ensure that there are always no more than 63 user editable state present.
   - Hid additional output labels in the 'Output Zoom' window when using devices with only eight outputs.
   - Additional communication checks during SE debug mode to check communication with device is operating correctly.

7. Evaluation board window
   - User modification of the evaluation board settings is now locked out for a few seconds upon entering the view to allow the software to update the    settings. This is to prevent the case where a user quickly made a change to a control which was immediately overwritten and ignored.

8. Communications Issues
   - If communications is lost with a device, and the user tries to recall a file from disk to download to the device it is no longer possible to select a    file.

9. File Recall/Save
   -  When working with the ADM1065 offline and saving a configuration to disk correct values are now written to the DACx and DPLIMx registers and EEPROM.     Files will now load correctly into an online ADM1065 session.
   - The last data location in the SE EEPROM was not include in the checksum calculation.
   - An ADM1068 - 9 file can no longer be recalled into anADM1062 - 67 device. An ADM1062 - 67 file can no longer be recalled into anADM1068-69 device both    online and offline.

10. Readback Window
   - There is no longer a forced single read when entering the window.
   - There is no longer a wait for GO bit to clear in continuous read mode.

Changes
========
1. Software now supports an ADI USB to IIC converter dongle as an additional method of communication with an evaluation board or micro-evaluation board.     This is an alternative to using the parallel to IIC converter cable where a PC does not have a parallel port.

2. The menu item to launch the Sequencers web page has been removed.

3. The SMBus Jump button is now always displayed on the Sequence Engine window, but is only enabled if a sequence contains an SMBus jump instruction.

4. Added note to all configurations files that they should not be edited by hand.

5. When entering debug mode, a warning is shown to remind the user to exit debug mode correctly.

6. User is now able to power cycle the device with going through the full device search.

7. Improved error reporting during lost comms/power, the user can now retry three times to re-connect to the device.

8. Added a voltage graph to the Readback window to show the ADC readings for the selected channels for certain modules.

9. Help tags added to user interface elements that previously had none.

Known Issues
============
1. Plugging an Evaluation board into an external non-powered USB hub can cause a machine to hang due to the power requirements of the board. It is    recommended to always plug the board into a USB port directly on the host PC.

2. If running under Windows XP, and the Appearance is changed to Windows Classic Style, the window size is incorrect and a small grey border will be visible    below the main view tab control.  This is purely a cosmetic issue, and can fixed by selecting the Windows XP style.

3. Due to limitations of the SE Debug mechanism, it is not possible to properly debug a sequence that contains a sequence statement based on the SMBus Jump    instruction and a time out based on the SMBus instruction as well. This affects only the ability to debug using the evaluation software, operation of the     ADM106x in normal mode is unaffected.

4. Putting a PC into sleep or a standby like mode while the evaluation software is using a USB interface may require the software to be restarted when the PC    is reactivated, and the evaluation board to be unplugged and then plugged back in again.

Version 4.0.1
Created May 10th 2007
*********************

Bug Fixes
==========
1. "Save Settings To File" and " Save Off-Line Settings To File"
   Bug - The Intel Hex checksum calculation was incorrect. The first line checksum of each EEPROM block was omitted from the calculation.

2. "Save Off-Line Settings To File"
   Bug - The Intel hex checksum was different when saved multiple times. The master checksum variable was not reset after each save.  

Version 4.0.2
Created May 28th 2007
*********************

Bug Fixes
==========
1. Installation
   - Unable to uninstall previous versions of ADM106x software. This is now fixed but will not uninstall version 4.0.0 and 4.0.1. This will require the user    to manually uninstall these versions by following the steps shown below:
   1. GOTO <Start>
   2. GOTO <Control Panel>
   3. GOTO <Add or Remove Programs>
   4. Highlight ADM106x Configuration Tool V4.0.0 or 4.0.1 and press "Remove" 

2. Log Files
   - The software was not handling the opened files correctly and was responsible for multiple open files.
   Now the software only opens one file and closes it after logging is complete.

Version 4.0.3
Created August 13th 2007
************************

Changes
========
1. In the register access window the 'update register' button only appears if the 'fault or status register' is selected from the tree.

Bug Fixes
==========

1. When single/multiple devices are connected and the software is gathering data from them during the initialization phase of the software the state machine     is paused, but is no longer reset by the software.

2. When using the 'Insert state' in the sequencing engine window, a warning window now appears to inform the user that it's not possible to insert a state       after the last state.

3. All the state pointers in the sequencing engine window operate correctly when using the 'Insert state' and 'Delete state' functions.

4. When in the Readback window if comms are lost then a pop up window will appear to show the problem.

5. The software start-up time has been reduced.

6. All states can now be seen when using the scroll bar in debug mode.

Version 4.0.4
Created October 16th 2007
*************************

Bug Fixes
==========

1. The state machine would reset when using the "upload device EEPROM contents to PC" function

2. The register tree view does not appear on certain machines caused by a missing active X file mscomctl.ocx.

Version 4.0.5
Created June 27 2008
*************************

New Features
=============
1.  An output option has been added to allow the user to visualize state machines in a graphical form. An open source tool called 'Graphviz' has been included as part of the installer and is used to automatically generate a PDF, JPEG, PNG or SVG format file that shows the relationship between the different states, and the different transistions between them. On the 'Sequence Engine' view tab, click the 'Create State Diagram' button to being the process.

2. The software is now installed into a folder inside the Analog Devices folder in the Programs menu item of the Start menu.  This is to follow the common practice of other ADI software tools.

3. Additional checking code was added to the software routines that search the I2C bus for devices to ensure that other ADM117x/9x devices are not detected and reported back as ADM106x devices.

Bug Fixes
==========

1. Display issues relating to fonts on certain machines have been fixed.  The font used by all controls has been reviewed and changed where necessary.

2. Corrected an issue on the Inputs configuration tab whereby if the UV/OV limits were incorrect, error message would appear in the window even if the input had been set to a digital input or turned off.

3. Some machines had an issue on the Register Access view where the 'Fix Display Error' button would be displayed when there was no display error. This is now no longer the case.

4. An error in how the Intel hex checksum was calculated in offline mode has been corrected.  This error caused an Intel Hex file to be created where the end of line checksum was incorrect and 2 bytes long, instead of 1 byte.

5. A difference in how unused memory locations were saved between online and offline mode has been fixed.  This change ensures that two otherwise identical configurations will have the same checksums.

Version 4.0.6
Created August 20 2009
**********************

Bug Fixes
==========

1.Error in the state diagram. The warnings condition was inverted.

Version 4.1.0
Created August 19th, 2010
**********************

1. New Feature – Now supports the ADM116x family of SuperSequencer devices that include non-volatile fault recording.

2. Changed - The software now uses a different driver to access the USB-SMBUS-CABLEZ USB to IIC Converter dongle. This requires the ADMxxxx run-time be installed as this provides access to the new driver.  Refer to the document 'Updating USB-IIC Dongle Driver' in the Common folder of the Analog Devices entry in the Start menu for more details.

Version 4.1.1
Created February 1st, 2011
**********************

Bug Fixes
=========
1.	Configuration files generated on computers using a locale setup to use something other than a period (‘.’) to indicate a decimal point no longer causes a problem when loaded on a system that does use a period for the decimal point.
2.	When saving files in online mode, and reloading them in offline mode, the margining window now correctly reflects the configuration of the DAC.  The DAC settings were being programmed and stored correctly in the file and device, but were not being updated correctly on the screen, unless the user had viewed the Margining tab while in Online mode. 

Version 4.2.0
Created February 20th 2012
**********************
1.	Added support for the USB-SDP-CABLEZ interface cable.

Bug Fixes
=========
1.	Fixed a problem determining device type when loading files due to use of different decimal point in locales.
2.	Fixed an issue reporting correct device type in file, when in offline mode and  when active device and device in file did not match.
3.	Fixed an issue with recognizing and initializing the USB-I2C dongle in virtual machine environments.  In such environments, the dongle must be set to automatically connect to the virtual machine otherwise the dongle initialization process will fail.
4.	Closing the ‘User and Black Box EEPROM’ Window using the ‘X’ control no longer causes the software to become unresponsive.

Version 4.2.1
Created June 6th 2012
**********************

Bug Fixes
=========
1.	Fixed a problem with detecting I2C interfaces, where if the USB-SDP-CABLEZ interface had never been connected to a PC, it could prevent other I2C interfaces from being detected.