Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man1 / scantest.1

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SCANTEST 1"
.TH SCANTEST 1 "2003-07-24" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
scantest \- Perl script for scan pattern generation.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
scantest [options] gate_level_netlist
.SH "ABSTRACT"
.IX Header "ABSTRACT"
\&\*(L"scantest\*(R" is a front-end interface for use of the ScanTest
package for automatic test pattern generation using FastScan.
\&\*(L"scantest\*(R" controls the creation of the test procedure file,
FastScan command file and execution script, as well as the
generation and simulation of test patterns.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The intention behind \*(L"scantest\*(R" is to simplify the \s-1ATPG\s0 flow.
If a design file conforms to the built-in defaults the entire
flow can be run by specifying only the design file:
.Sp
.RS 4
scantest design_file
.RE
.PP
The default design settings are as follows:
.IP "\(bu one scan chain" 4
.IX Item "one scan chain"
.PD 0
.ie n .IP "\(bu clock port is named ""clk""" 4
.el .IP "\(bu clock port is named ``clk''" 4
.IX Item "clock port is named clk"
.ie n .IP "\(bu scanin port is named ""si""" 4
.el .IP "\(bu scanin port is named ``si''" 4
.IX Item "scanin port is named si"
.ie n .IP "\(bu scanout port is named ""so""" 4
.el .IP "\(bu scanout port is named ``so''" 4
.IX Item "scanout port is named so"
.ie n .IP "\(bu scanenable port is named ""se""" 4
.el .IP "\(bu scanenable port is named ``se''" 4
.IX Item "scanenable port is named se"
.PD
.PP
If the design does not conform to these defaults, switches
are available to modify the operation of \*(L"scantest\*(R".
.Sh "\s-1OPTIONS\s0"
.IX Subsection "OPTIONS"
.IP "\-[no]atpg" 4
.IX Item "-[no]atpg"
Run atpg only. If the option is negated, only simulation
is performed. This is the same as specifying \*(L"\-sim\*(R"
.IP "\-bb or \-blackbox" 4
.IX Item "-bb or -blackbox"
Enable automatic black box recognition. Typically this option
should not be required. The switch can be used to force
continuation of the flow in the presence of missing cells.
Coverage is likely to be poor.
.Sp
Before setting this switch the user is advised to check that
correct version of the library is being referenced and that
all verilog files have been specified.
.Sp
In the event that a view is known to be missing (such as a
memory block) this switch will need to be specified.
.IP "\-clk" 4
.IX Item "-clk"
Introduces a comma separated list of rising edge active clocks.
Default settings are overridden. Default names must be given
explicitly if needed.
.IP "\-comb" 4
.IX Item "-comb"
Specifies that the block has no sequential cells. Normally
\&\*(L"scantest\*(R" searches for the presence of default or user
specified clock ports. Specifying \*(L"\-comb\*(R" suppresses this
behavior.
.IP "\-design" 4
.IX Item "-design"
Optional switch that introduces a single design file.
.IP "\-dftlib" 4
.IX Item "-dftlib"
Allows a non-default FastScan library to be specified.
.Sp
The \s-1DFT\s0 library is normally \*(L"$LIBDIR/u1/atpg/u1.mdl\*(R".
This switch is provided for library debug purposes. Do not
use it in the normal flow!
.IP "\-[no]dofile" 4
.IX Item "-[no]dofile"
If set, this switch causes only the FastScan command file
(dofile) to be generated.
.Sp
If negated, the switch allows the flow to proceed without
generating a new default command file. The command file
should be already present. This switch allows the user
to develop a custom command file.
.IP "\-dumpdir" 4
.IX Item "-dumpdir"
Allows a non-default dump directory to be specified.
.Sp
By default, \*(L"scantest\*(R" creates a dump area for simulation
files in either \*(L"/export/home/bw\*(R" (scratch area available
when running under dream) or \*(L"/tmp\*(R". The user is free to
choose somewhere else.
.Sp
A subdirectory composed of the user's name and process
id is created into which the simulation files are dumped.
.RS 4
.Sp
.RS 4
\&\s-1NOTE:\s0 The dump directory is never cleaned out. The user
is responsible for ensuring that unnecessary files are
removed.
.RE
.RE
.RS 4
.RE
.IP "\-flist" 4
.IX Item "-flist"
Specifies verilog include files. This switch is necessary
if the design is spread over multiple files.
.Sp
By default no include files are assumed.
.IP "\-fslog" 4
.IX Item "-fslog"
Specifies an alternate name for the fastscan log file.
.IP "\-help" 4
.IX Item "-help"
Prints the list of switches with brief descriptions and
default settings.
.IP "\-hi" 4
.IX Item "-hi"
Introduces a comma separated list of input ports which
need to be contrained high.
.Sp
By default none are assumed.
.IP "\-lo" 4
.IX Item "-lo"
Introduces a comma separated list of input ports which
need to be contrained low.
.Sp
By default none are assumed.
.IP "\-ph1" 4
.IX Item "-ph1"
Introduces a comma separated list of rising edge active clocks.
This switch is an alias for \*(L"clk\*(R".
.IP "\-ph2" 4
.IX Item "-ph2"
Introduces a comma separated list of falling edge active clocks.
.Sp
By default none are assumed.
.IP "\-[no]runfile" 4
.IX Item "-[no]runfile"
If set, this switch causes only the FastScan run file to be
generated.
.Sp
If negated, the switch allows the flow to proceed without
generating a new default run file. The run file needs to
be already present. This switch allows the user to invoke
FastScan with customized settings.
.IP "\-se" 4
.IX Item "-se"
Introduces a comma separated list of scanenable ports.
Typically, only one scan enable port is expected. This
switch is provided to specify a non-default port name.
.Sp
In the event that the default name, \*(L"se\*(R", is also required
it needs to be explicitly specified.
.IP "\-si" 4
.IX Item "-si"
Introduces a comma separated list of scanin ports. The
default setting is overwritten. If the default name, \*(L"si\*(R",
is also required it needs to be explicitly specified.
.Sp
The order of the scanin ports must match that of the
corresponding scanout ports.
.IP "\-[no]simulation" 4
.IX Item "-[no]simulation"
If set, this switch causes only simulation to be performed.
If negated, the switch halts the flow after pattern
generation.
.IP "\-smalljob" 4
.IX Item "-smalljob"
Selects a 20 minute FastScan license. This works for small
jobs when no licence is available on the default large queue.
.IP "\-so" 4
.IX Item "-so"
Introduces a comma separated list of scanout ports. The
default setting is overwritten. If the default name, \*(L"so\*(R",
is also required it needs to be explicitly specified.
.Sp
The order of the scanout ports must match that of the
corresponding scanin ports.
.IP "\-[no]tpfile" 4
.IX Item "-[no]tpfile"
If set, this switch causes only the FastScan test procedure
file to be generated.
.Sp
If negated, the switch allows the flow to proceed without
generating a new default test procedure file. The test
procedure file should be already present. This switch allows
the user to develop a custom protocol.
.IP "\-top" 4
.IX Item "-top"
This switch specifies the name of the top module. By default
the top module name is taken from the root of the design
file. The switch is necessary if the top module name does
not match the design file name or if there are multiple top
modules present.
.IP "\-verbose" 4
.IX Item "-verbose"
If set, this switch will cause untestable fault information
to be added to the \s-1ATPG\s0 log file. If coverage is low, this
additional information could be large.
.IP "\-vverbose" 4
.IX Item "-vverbose"
The \*(L"vverbose\*(R" flag adds instance coverage information to
the \s-1ATPG\s0 log file. If the design file contains a large number
of instances, printing the additional statistics slows down
the flow and increases the size of the log file.
.IP "\-vlist" 4
.IX Item "-vlist"
Allows multiple design files and/or libraries to be listed
in a separate file. Internally this switch is used to reference
the m1 library (\*(L"$LIBDIR/m1/compiled/m1.vL\*(R"). If this switch
is used and the m1 library also needs to be referenced the
library must be explicitly specified.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
\&\*(L"scantest\*(R" uses two environment variables:
.IP "\s-1LIBDIR\s0" 4
.IX Item "LIBDIR"
Specifies the location of the design libraries.
.IP "\s-1USER\s0" 4
.IX Item "USER"
Identifies where the default dump directory will be created.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIScanTest\fR\|(3), http://www.mentor.com/dft
.SH "AUTHOR"
.IX Header "AUTHOR"
Roger Mistely, <roger.mistely@sun.com>