SpyGlass ReadMe

SpyGlass® Download and Installation Instructions

Dear Atrenta User,

Welcome to the Atrenta® SpyGlass® Version 4.7.1.

This document describes the SpyGlass 4.x download and installation instructions for the latest release of SpyGlass.

NOTE: You have to use gtar or the itar that is included on the ftp site to untar. Do not use Sun tar.

NOTE: Please download this release only and ignore any other releases that may be on the ftp site. You will be notified when new releases are available.

A. Download Atrenta 4.x release filePlease pick up the latest Atrenta 4.x release from the Atrenta ftp site as per details sent to you in e-mail.

You will need to download the following files (remember to use binary download by typing bin at the ftp prompt):

NOTE: You do not need to download the Builder file (SpyBuilder-4.x.y.tar.gz) if you have not purchased the SpyGlass Builder feature.

NOTE: Starting with the SpyGlass 3.9.0.1 release, platform-specific tar files are

Software/Document Filename

Release (Checker) SpyGlass-4.x.y.tar.gz

Release (Builder) SpyBuilder-4.x.y.tar.gz

Release Notes SpyGlass_ReleaseNotes.pdf

KPNS SpyGlass_KPNS.pdf

Fixed VIs SpyGlass_FixedIncidents_RelNotes.pdf

These notes SpyGlass_ReadMe.pdf

Extraction Utility itar.sol

SpyGlass® Download and Installation Instructions ©Copyright 2001-2012 Atrenta Inc. All rights reserved. 1


available for smaller ftp downloads. Please refer to the download instructions attached with the release notification email for further details.

If you need any assistance or if you have problems running the tool, please do not hesitate to contact Atrenta at [email protected] or 1-866-ATRENTA.

B. Installation (all UNIX platforms)

1. Installing the software1. Create your installation directory.

2. Unpack the SpyGlass-<rev>.tar.gz file and the SpyBuilder-<rev>.tar.gz file (if you are using the SpyGlass Builder feature) in your installation directory:

% gtar xvzf SpyGlass-<rev>.tar.gz

% gtar xvzf SpyBuilder-<rev>.tar.gz

NOTE: DO NOT USE VENDOR-SUPPLIED TAR PROGRAMS. SOME OF THESE HAVE KNOWN BUGS, WHICH MAY CAUSE AN INCOMPLETE INSTALL AND SUBSEQUENT UNEXPECTED BEHAVIOR.

NOTE: You should first unpack the SpyGlass-<rev>.tar.gz archive and then the SpyBuilder-<rev>.tar.gz archive in the same directory when you are installing both the SpyGlass Checker and the SpyGlass Builder features.

2. Add SpyGlass to your environmentUse one of the following methods (2a or 2b below) to add SpyGlass to your environment:

2a: Insert the following in your ~/.cshrc file

% setenv ATRENTA_LICENSE_FILE <license_file_path>

% set path = (<your-inst-dir>/SPYGLASS_HOME/bin $path)

2b: Insert the following in your ~/.bashrc file

% export ATRENTA_LICENSE_FILE=<license_file_path>

% export PATH=”<your-inst-dir>/SPYGLASS_HOME/bin:$PATH”

NOTE: You can also use the LM_LICENSE_FILE environment variable for this

2 Version 4.7.1


purpose. However, it may be slower if many license servers are specified.

3. Run the FLEXlm license daemon on its host machine

% rlogin <license-host>

on Linux (32 bit):

% <your-inst-dir>/SPYGLASS_HOME/flexlm_v950/i86_r6/lmgrd-c license.dat

on Solaris (32 bit):

% <your-inst-dir>/SPYGLASS_HOME/flexlm_v950/sun4_u5/lmgrd-c license.dat

on Linux (64 bit):

% <your-inst-dir>/SPYGLASS_HOME/flexlm_v950/amd64_re3/lmgrd-c license.dat

on Solaris (64 bit):

% <your-inst-dir>/SPYGLASS_HOME/flexlm_v950/sun64_u5/lmgrd-c license.dat

4. Check if the installation works

% cd <your-inst-dir>/SPYGLASS_HOME/examples/vhdl-files

% spyglass -vhdl test1.vhd

Then, select [RUN] inside the graphical interface.

% cd <your-inst-dir>/SPYGLASS_HOME/examples/verilog-files

% spyglass -verilog test.v

Then select [RUN] inside the graphical interface.

5. If you want to run the Power Estimation Policy in Timing Optimization mode (Linux 32-bit platform only)

For this purpose, you need to download and install the SpyGlass Timing and Optimization package as follows:

Version 4.7.1 3


1. Download the SpyGlass Timing and Optimization archive (SpyGlass-4_1_0-tao-1_17.tar.gz) from the same location from where you downloaded the main SpyGlass archive.

2. Unarchive the SpyGlass Timing and Optimization archive in the <your-inst-dir>/SpyGlass-x.y.z directory where <your-inst-dir> is the directory where you installed SpyGlass.

Your Timing and Optimization package is ready to work!

See the SpyGlass Power Estimation Rules Reference for further details.

C. Check the installationThe top-level directory structure of a SpyGlass installation is as follows:

The SPYGLASS_HOME directory contains the following sub-directories:

File/Directory Purpose

SpyGlass_ReleaseNotes.pdf Release Notes for this release.

SpyGlass_KPNS.pdf Known Problems and Solutions for this release.

SpyGlass_FixedIncidents_RelNotes.pdf The list of recently-fixed problem reports.

SpyGlass_ReadMe.pdf This document

SpyGlass_Version,SpyBuilder_Version

Version files

ace/ Support files for Periscope Waveform Viewer

dotty/ Waveform Viewer (for LowPower policy)

perl/ A Perl 5.8.3 installation for SpyGlass.

tcl/ SDE support files

waveform/ Periscope Waveform Viewer

SPYGLASS_HOME/ The SpyGlass installation itself.

Directory Contains...

auxi/ Auxiliary files for use by SpyGlass.

4 Version 4.7.1


You should create a new directory, ../../SpyGlass_templates, relative to the SPYGLASS_HOME directory, for storing user-defined templates. This directory will be searched by SpyGlass for site-default templates. Please see the SpyGlass Predictive Analyzer User Guide for details.

D. Using SpyGlassNOTE: This section is not applicable for OEM users because they use only OEM set of policies.

Usage:

spyglass -vhdl <vhdl-options> ...vhdl-files...spyglass -verilog <verilog-options> ...verilog-files...spyglass -mixed <vhdl-options> <verilog-options> ...vhdl-files... ...verilog-files...

bin/ The platform-independent executable;this area should be in the user’s $PATH.

compat/ 37x version templates

doc/ SpyGlass’ User Documentation

dw_support/ DesignWare component support files

examples/ SpyGlass Examples

flexlm_v950*/ The FLEXlm license server executable

htmlhelp/ HTML-based documentation

include/ SpyBuilder support files

lib/ The ruledeck libraries and perl modules

obj/ Platform-dependent executable files;These should not be executed directly;This area should *not* be in the user’s $PATH.

policies/ All standard Atrenta policies within their individual policy folders

templates/ For Atrenta Flow05 templates

training/ Periscope and SpyGlass Training documents and files

vhdl_libs/ The predefined libraries for VHDL (*.vhd and *.dmp)

wizard/ The Clock-Reset policy setup wizard (internal utility)

Directory Contains...

Version 4.7.1 5


SpyGlass options are explained in the SpyGlass Predictive Analyzer User Guide in detail. A few examples are given here.

1. Check all available rules using standard installed rules

spyglass -vhdl test1.vhdspyglass -vhdl -policies=lint test1.vhdspyglass -vhdl -policies=openmore test1.vhd

spyglass -verilog test.vspyglass -verilog -policies=lint test.vspyglass -verilog -policies=openmore test.v

spyglass -mixed test.vspyglass -mixed -policies=lint test1.vhdspyglass -mixed -policies=openmore test.v test1.vhd

2. Check only one or more rules using standard installed rules, e.g. for Lint

spyglass -vhdl -policies=lint -rules “rule1 rule2” test.vhdspyglass -verilog -policies=lint -rules “rule1 rule2” test.vspyglass -mixed -policies=lint -rules “rule1 rule2” test.v test1.vhd

3. Supply your own perl rule file. Please refer to the Policy Customization Guide on how to write your own policy files (extra licenses may be required for both development and end users)

For a custom policy file, named myrules-policy.pl and placed in a directory (any name) inside the /policies directory:

spyglass -vhdl -policies=myrules test.vhdspyglass -verilog -policies=myrules test.vspyglass -mixed -policies=myrules test.v test1.vhd

4. Check a subset of the rules from your own rules file

spyglass -vhdl -policies=myrules -rules “rule1 rule2” test.vhdspyglass -verilog -policies=myrules -rules “rule1 rule2” test.vspyglass -mixed -policies=myrules -rules “rule1 rule2” test.v test1.vhd

6 Version 4.7.1


E. Quick basic command reference for new usersspyglass -version //show SpyGlass checker’s version.spyglass -usage //show the standard option set.spyglass -help //show site-specific help.spyglass -quickstart //show the ‘quick start’ help.

To find out more about rules that are checked by SpyGlass, type:

spyexplain -verilog

To print information on all Verilog rules

spyexplain -vhdl

To print information on all VHDL rules

spyexplain <rule-name>

To print information on the named rule (for example, spyexplain SigName)

spyexplain -verilog -k <word>

Print all Verilog rules containing the word <word>

spyexplain -vhdl -k <word>

Print all VHDL rules containing the word <word>

spyexplain -verilog -k <word>

F. Display Setting RequirementsThe SpyGlass Graphical User Interface (GUI) can be best viewed with 32-bit (or higher) color settings of your screen display.

G. Documentation

The Atrenta documentation is available as follows:

HTML-based On-line Help System (The spyhelpviewer utility)

PDF Format Documentation (The spydocviewer utility)

Version 4.7.1 7


The spyhelpviewer utilityThe spyhelpviewer utility displays the Atrenta documentation in HTML format arranged in a tree format for easy access.

You can invoke the Atrenta Documentation System (HTML-based) by executing the spyhelpviewer command or by selecting the Help > On-line Help menu option from the SpyGlass Design Environment.

By default, the spyhelpviewer utility searches for the netscape executable in your machine’s path for displaying the HTML files. Use the SG_HTML_BROWSER environment variable to set your HTML Browser.

FIGURE 1. Atrenta HTML-based On-line Help System

The HTML-based Online Help system has the following:

1. The Contents tab that shows all topics arranged in a hierarchical tree

2. The Index tab that has the index entries for the complete documentation set

3. The Search tab for search across the complete documentation set

8 Version 4.7.1


4. The Favorites tab for collecting a set of related topics for viewing

5. The Topic display page

System RequirementsThe HTML-based On-line Help system works on a UNIX computer running version 4 or later of Internet Explorer or Netscape or a current version of Mozilla, or Safari. The underlaying engine has also been tested with Mozilla. JavaScript must be enabled in the user's browser.

To view the Java implementation of the Help system, Java must be enabled in the user's browser.

Known Limitations1. Netscape 6.0 is not supported on any platform; Netscape 6.1 and later are

supported.

2. The underlying engine may also work with Opera and other browsers, but it has been tested only with Internet Explorer, Netscape, Mozilla, and Safari.

The spydocviewer utilityThe spydocviewer utility displays the Atrenta Documentation in PDF format arranged in a tree format for easy access. In addition, the Atrenta Standard Rule-Primitive documentation (in text format) is also accessible.

By default, the spydocviewer utility searches for the acroread or xpdf executables in your machine’s path for displaying the PDF files. Set the SG_PDF_VIEWER environment variable to set your PDF viewer.

You can invoke the Atrenta Documentation System (PDF format) by executing the spydocviewer command or by selecting the Help > On-line Manuals menu option from the SpyGlass Design Environment.

Version 4.7.1 9


FIGURE 2. Atrenta Documentation (PDF Format) Browser

Click on the + button next to a category to view the PDF books available under that category. To open a PDF book, double-click on a PDF book name or select the book by clicking it name and then click Open.

Click Exit to exit the Atrenta Documentation (PDF format) Browser.

H. How to customize rulesPlease refer to the SpyGlass Policy Customization Guide.

End of the Document

10 Version 4.7.1

SpyGlass ReadMe

Documents

Transcript of SpyGlass ReadMe