Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / ScanTest.3
CommitLineData
86530b38
AT
1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "ScanTest 3"
132.TH ScanTest 3 "2003-07-28" "perl v5.8.0" "User Contributed Perl Documentation"
133.SH "NAME"
134ScanTest \- Perl module for scan pattern generation.
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& use ScanTest;
139.Ve
140.PP
141.Vb 1
142\& BlockFlow();
143.Ve
144.SH "ABSTRACT"
145.IX Header "ABSTRACT"
146.Vb 5
147\& ScanTest is a parameterizable package for automatic test pattern
148\& generation using FastScan. The package supports creation of the
149\& test procedure file, FastScan command file and execution script,
150\& and provides control for the generation and simulation of test
151\& patterns.
152.Ve
153.SH "DESCRIPTION"
154.IX Header "DESCRIPTION"
155The ScanTest module contains procedures to manage automatic test
156pattern generation using FastScan. By default it exports the
157procedure \*(L"BlockFlow\*(R". This procedure allows the user to generate
158and simulate block level scan patterns. The routines called by
159\&\*(L"BlockFlow\*(R" are generic, being tied to a project by means of a
160configuration file \*(L"ScanTest.cfg\*(R".
161.PP
162Optionally the module exports the procedure \*(L"LibraryFlow\*(R". This
163set of routines is specific to Niagara and is responsible for
164generating test patterns for the m1 and u1 libraries. \*(L"LibraryFlow\*(R"
165is not intended for general use and is not discussed further in this
166document.
167.Sh "\s-1EXPORT\s0"
168.IX Subsection "EXPORT"
169ScanTest exports the procedure \*(L"BlockFlow\*(R". The procedure takes
170no arguments. Instead three levels of customization are
171available:
172.IP "Command Line Switches" 4
173.IX Item "Command Line Switches"
174Command line switches are the means by which users can tailor
175the flow to suit their needs. Switches are provided to:
176.RS 4
177.IP "\(bu specify design files and top module" 4
178.IX Item "specify design files and top module"
179.PD 0
180.IP "\(bu override default library settings" 4
181.IX Item "override default library settings"
182.IP "\(bu override default pin constraints" 4
183.IX Item "override default pin constraints"
184.IP "\(bu suppress intermediate file generation" 4
185.IX Item "suppress intermediate file generation"
186.IP "\(bu execute a partial flow sequence" 4
187.IX Item "execute a partial flow sequence"
188.IP "\(bu perform miscellaneous operations" 4
189.IX Item "perform miscellaneous operations"
190.RE
191.RS 4
192.PD
193.Sp
194A full list of switches and their defaults can be displayed by
195specifying the \*(L"\-help\*(R" option.
196.RE
197.IP "Configuration File" 4
198.IX Item "Configuration File"
199The configuration file \*(L"ScanTest.cfg\*(R" contain default settings
200for libraries, constrained pins and variables used in the
201generation of intermediate files. The purpose of the configuration
202file is to tailor the flow to the needs of the project. The
203configuration file is released as a supplement to the package
204and is not intended for modification by the user.
205.IP "Psuedocode Files" 4
206.IX Item "Psuedocode Files"
207Psuedocode templates exist for the generation of the FastScan
208test procedure file and command file (do file). The templates
209identify the structure of the files. They mix verbatim syntax
210with psuedocode constructs. The psuedocode is expanded at run
211time to include variables contained in the configuration file
212and iterated as necessary over a set of constrained pins.
213.Sp
214Currently the templates are released as a supplement to the
215package and are not intended for modification by the user.
216.SH "SEE ALSO"
217.IX Header "SEE ALSO"
218\&\fIscantest\fR\|(1), http://www.mentor.com/dft
219.SH "AUTHOR"
220.IX Header "AUTHOR"
221Roger Mistely, <roger.mistely@sun.com>