README.TXT ----------------------------------------------------- FS2 CLAM(tm) System Copyright (C) 1998-2004 First Silicon Solutions, Inc. ----------------------------------------------------- File contents: - Overview - Installation - Documentation overview - HW Breakpoints Window - Mentor/ATI code|lab - MIPS GDB/Insight - Change history in reverse chronological order - Known issues =============== Overview =============== The FS2 System Analyzer for QuickLogic® QuickMIPS Devices combines a MIPS 4Kc CPU debugger with a configurable logic analyzer, providing a uniquely powerful integrated tool. While the logic analyzer and debugger are largely independent, the MIPS processor can be stopped from the off-chip analyzer, enhancing the on-core breakpoints with events that include signals outside the core. The system analyzer consists of a Command-Line Interface (CLI), Application Binary Interface (ABI), logic analyzer GUI, future source-level debugger, and FS2 hardware. The CLAM logic module is available in an on-chip version, where trace and trigger recognition is accomplished in the QuickLogic® QuickMIPS FPGA Fabric, and an off-chip version, where trace and trigger recognition is accomplished in the FS2 hardware. Two System Analyzer hardware probes are available. The on-chip version connects only to the on-chip module in the QuickMIPS Device. The universal version can connect to the on-chip and the off-chip logic modules. A companion product, FS2 System Analyzer for QuickLogic® Eclipse Devices , provides just the logic analyzer for FPGA systems other than QuickMIPS. =============== Installation =============== To install the CLAM software, run the setup program, setup.exe. If you have downloaded the software from FS2's website, the setup file will be called ISA-QMips-XXXX.exe, or ISA-Eclipse-XXXX.exe where XXXX is the software version. The CLAM OCI files are contained in the install file, oci-clam-ql-XXXX.exe, where XXXX is the revision number. ====================== Documentation overview ====================== * FS2 CLAM FAQ For QuickLogic® QuickMIPS and Eclipse Devices This document addresses frequently asked questions about the CLAM IP. It is installed as part of the FS2 CLAM OCI. It is also installed as part of the FS2 CLAM System and can be accessed from the start menu (Start -> Programs -> FS2 -> ISA-QMIPS FAQ; or Start -> Programs -> FS2 -> ISA-Eclipse FAQ). * FS2 CLAM Instantiation, Simulation and Synthesis Guide This document contains instantiation, simulation and synthesis instructions with examples in Verilog and VHDL for QuickLogic QuickMIPS and Eclipse Devices. It is installed as part of the FS2 CLAM OCI. It is also installed as part of the FS2 CLAM System and can be accessed from the start menu (Start -> Programs -> FS2 -> ISA-QMIPS CLAM Instantiation Guide; or Start -> Programs -> FS2 -> ISA-Eclipse CLAM Instantiation Guide). * Getting Started This document presents a quick overview explaining how to connect the FS2 CLAM Probe, and provides an introduction to the CLAM software. It is installed as part of the FS2 CLAM System and can be accessed from the start menu (Start -> Programs -> FS2 -> ISA-QMIPS Getting Started Manual; or Start -> Programs -> FS2 -> ISA-Eclipse Getting Started Manual). * QuickMIPS Fabric + CLAM Demo This document describes the default hardware programmed into the fabric of the QuickMIPS device that is installed on every SDK board, the interconnection to the internal CLAM, and the means for the software to interact with the hardware. It is installed as part of the FS2 CLAM System and can be accessed from the start menu (Start -> Programs -> FS2 -> ISA-QMIPS Fabric + CLAM Demo). =============== HW Breakpoints Window =============== The Window menu contains a window called HW Breakpoints to graphically set up instruction and data breakpoints. =============== Mentor/ATI code|lab =============== FS2 supports Mentor/Accelerated Technology's code|lab product using the MIPS MDI (Microprocessor Debug Interface). The FS2 MDI driver is installed when code|lab is installed. To connect to the FS2 software, choose the "MDI Connection" when the Connect dialog box comes up. (If it does not come up automatically, choose the "Connect to Target" option under the Target menu item.) Under Setup, the MDI model should be "ISA-QMIPS" and microprocessor family should be "MIPS 4K". Choose "Configure" and confirm your target settings (choose "Advanced" for more options). Click OK in "Configure" to return. Then, click OK and choose "Connect" to connect to the target. If there is a connection failure, you may have to set up the port and other "config" items. See the FS2 Getting Started manual. code|lab supports Windows NT, 2000, and XP. =============== MIPS GDB/Insight =============== MIPS GDB/Insight is available in the MIPS™ Software Toolkit. The MIPS™ Software Toolkit consists of MIPS® SDE GNU based toolchain, MIPSsim™ Instruction Set Simulator, MIPS™ DSP Library and technical support. Visit: http://www.mips.com/content/Products/SoftwareTools/Software_Toolkit/content_html The MIPS® SDE GNU based toolchain is available alone as part of MIPS® SDE Lite, "MIPS® Free GNU Toolkit". Visit: http://www.mips.com/content/Products/SoftwareTools/SDE_Lite/content_html These toolkits include the GDB debugger which FS2 supports through the MDI (Microprocessor Debug Interface). See Appendix G in the Getting Started manual for more information. GDB/Insight supports Windows NT, Windows 2000, and Windows XP. ============== Change history ============== Changes in 1.7.7.6 ------------------ - Fix GPF in start-up of code|lab (current version 1.6.3). - Add memcache command. - Add "Getting Started..." link to Console help menu. Changes in 1.7.7.3 ------------------ - Correct "config diagbits" default. The fs2.log file will now display the initialization sequence and turn off unless diagbits specified. Use "config diagbits 0x7FFFFFFF" to turn log on when reporting a problem. Changes in 1.7.7.1 ------------------ - Added support for wider (up to 256) on-chip CLAM, more events and states. - Fixed problem scenario where bus values in waveform view that were 2 samples after a gap could show the wrong numeric value. Changes in 1.7.7.0 ------------------ - ConnectHalt/ConnectReset working. See "config" for details. - Add GDB support. - Fixed initialization problem supporting code|lab. - Add CLAM Instantiation Guide to the start menu. Changes in 1.7.6.5 ------------------ - Lpt port is closed for MDI applications. Changes in 1.7.6.4 ------------------ - Fixed problem in displaying data from smaller (10-bit, 15-bit) event widths. Changes in 1.7.6.3 ------------------ - Fix big endian issue with DCR register. Changes in 1.7.6.2 ------------------ - Support latest MDI changes for 3rd party tools. Changes in 1.7.6.1 ------------------ - Added support for "universal" CLAM hardware that works with both on-chip and off-chip configurations of CLAM. - Added support for ConnectReset and ConnectHalt "config" items. Changes in 1.7.5.6 ------------------ -Added QuickMIPS Console "config" items Coherent. -ConnectReset and ConnectHalt "config" items added to documentation but not supported yet. -Breakpoints and triggers set in CLAM Console are honored by 3rd party MDI apps. -Big endian fixes. -Added cache commands, copc, execute, trigger -enable/-disable. Changes in 1.7.5.3 ------------------ - Added ability to change waveform height and spacing. - Added ability to alternate background of adjacent trace waveforms, making it easier for the eye to follow traces across the screen. - Added click-and-drag waveform zooming. Changes in 1.7.5.1 ------------------ - For configurations that support timestamped trace (4x25), qualified trace gaps in the waveform are now drawn to actual scale. Changes in 1.7.4.8 ------------------ - Incorporated new flash image for 4x25 configuration. - State display now has "gap" indicator, and its colors are now configurable. Changes in 1.7.4.7 ------------------ - Incorporated new flash image for 4x25 configuration. - Added document describing CLAM/QMIPS cross-triggering. Changes in 1.7.4.6 ------------------ - Corrected 10-second delay issue with QMIPS MDI connection. Changes in 1.7.4.5 ------------------ - Incorporated new flash image for 4x25 configuration. Changes in 1.7.4.4 ------------------ - Add ClamTrigoutBreak to Advanced tab in source level debugger connection dialog. Changes in 1.7.4.3 ------------------ - Fix for 32-bit flash writing problem. Changes in 1.7.4.2 ------------------ - Add config ClamTrigoutBreak option to cross-trigger from CLAM to MIPS. Changes in 1.7.4.1 ------------------ - Added ability to export data in VCD format - Fixed "Invalid state bit" problem with loading internal CLAM config files. Changes in 1.7.3.6 ------------------ - Add connection dialog box support for 3rd party MDI debuggers. Changes in 1.7.3.3 ------------------ - Added state display pane with optional support for user-defined symbols - Dialog box for editing event bus values can now handle editing more than one bus without dismissing the dialog. version 1.7.2.3 ------------------ - Fixed problem with initialization race condition (causing processor reset) related to 3rd party MDI debug interface. version 1.7.2.2 ------------------ - Added support for 3rd party MDI debug interface. Changes in 1.7.2.1 ------------------ - Triggering no longer turns off trace qualification. - Added option for automatic detection of clock rate for external CLAM. Changes in 1.7.1.3 ------------------ - Incorporated new parallel port driver. - ECP support added. - Added C1/C2/trigger labels in waveform "ruler". - Getting Started manual is now available from Help menu. - Signal/Bus tree expansion state is now saved/restored using configuration file. - Toolbar positioning is now remembered between usages. - Addressed several minor UI issues. Changes in 1.7.1.1 ------------------ - Added CLAM GUI features: * Complex triggers * File-based save/restore of configuration * Color selection for waveform elements * Event "find" in waveform Changes in 1.7.0.1 ------------------ - Addressed some documentation issues with product naming. - Fixed some problems with registry access that were specific to Windows 9X. Changes in 1.6.1.3 ------------------ - Fixed a crash problem with CLI config command. - Fixed a general problem with certain EPP port hardware. Changes in 1.6.1.2 ------------------ - Fixed problem with CLAM GUI appearing in MDI. Changes in 1.6.1.1 ------------------ - Fixed problem in detection of trace wrap condition. Changes in 1.6.0.4 ------------------ - Support MDI specification with fs2i.dll (internal) and fs2x.dll (external) DLLs. Changes in 1.5.10.2 ------------------ - Fixed problems in vertical scrolling of content (when app window was dimensioned such that vertical scrolling was necessary). - Fixed problem with column reordering in the signal/bus pane. - Addressed miscellaneous usability issues. Changes in 1.5.10.1 ------------------ - Addressed some threading issues that could otherwise result in data corruption. - Improved handling of hardware connection errors when starting up. - Miscellaneous bug fixes and cleanup - Getting started documents have been updated to include new GUI - Installation was fixed so that FS2.INI manipulation is no longer required to choose between internal vs. external vs. simulator. There are now separate icons for each of these. Changes in 1.5.9.1 ------------------ - Replaced Tk waveform window with native Windows GUI. Changes in 1.5.8.1 ------------------ - Changed register save sequence to eliminate unnecessary and potentially harmful writes to coprocessor registers. Changes in 1.5.3.2 ------------------ - Fixed bug in S-record and Intel-Hex loaders. Memory operations were being performed to virtual memory addresses rather than physical addresses. - Fixed bug in memory write function that wrote incorrect data in certain cases. - Added "cop" command to access any coprocessor register. - Added config command option to print list of current config settings when no arguments are given. Changes in 1.4.3.2 ------------------ - Clarifications and corrections in documentation. - Fixed Tcl script problem when using 4 states with External CLAM. Changes in 1.4.3.1 ------------------ - Added Off-chip CLAM support. Changes in 1.4.2.7 ------------------ Original version. ============== Known Issues ============== =============== Contacting FS2 =============== Please contact FS2 with any comments or questions: First Silicon Solutions, Inc. 4000 SW Kruse Way Place Bldg 3, Suite 210 Lake Oswego, OR 97035 (503) 489-0311 voice (503) 489-0315 fax http://www.fs2.com Sales support: info@fs2.com (503) 489-0311 x103 Technical support: support@fs2.com (503) 489-0311 x104