Initial version of donated sources by Avertec, 3.4p5.
[tas-yagle.git] / distrib / sources / man / man5 / spi.5
1 .TH SPI 5 "30 March 2000" "AVERTEC" "File Formats"
2
3 .SH NAME
4
5 spi \- parser for Spice netlist.
6
7 .so man1/avt_origin.1
8
9 .SH FILES
10
11 The description of a netlist foo must be contained in a \fB.SUBCKT\fP of a file named \fIfoo.spi\fP. This description can include others \fB.SUBCKT\fP that must be in the same file or files included with the command \fB.INCLUDE\fP in the source file.
12
13 Recognized elements are :
14
15 .RS
16 Resistances
17
18 Capacitances
19
20 Instances
21
22 MOS transistors.
23
24 .RE
25 Others elements are not considered.
26
27 Nodes can be either numbered or nameed. It's possible to assign a name to a node which is designated by a number with the directive
28
29 .B * NET number = name
30
31 in the \fB.SUBCKT\fP. The word NET can be replaced by positioning the environment variable \fIMBK_SPI_NETNAME\fP. Names are used to named the signals and the connectors in the model.
32
33 On the \fB.SUBCKT\fP interface, nodes of the same name followed by a period and a number are considered to be on the net, even if no connected in the circuit. For example :
34
35 .RS
36 .SUBCKT nand2 in out out.1 out.2 vss vdd out.3
37 .RE
38
39 The nodes out, out.1, out.2 and out.3 are considered to be the same signal of the spice model. This feature can be turned off if the environment variable \fIMBK_SPI_MERGE\fP is set, and the period can be replaced by another character with the environment variable \fIMBK_SPI_SEPAR\fP.
40
41 No particular information is needed to build a model from a \fB.SUBCKT\fP, the parser rebuild all signals, even they contains many resistances and capacitances. If names are not provided, the parser will create then in order to provide a valid model.
42
43 .SH PARSER
44
45 The parser load all \fB.SUBCKT\fP in memory, even those in files included with the command \fB.INCLUDE\fP until the required model is loaded. For each \fB.SUBCKT\fP loaded, the parser build the equipotentials with both nodes of resistances on the same net and both nodes of capacitances on differents net unless more information is given.
46
47 Environment variable considered are
48
49 .RS
50 .B MBK_SPI_TN
51
52 .B MBK_SPI_TP
53
54 .B MBK_SPI_NETNAME
55
56 .B MBK_SPI_SEPAR
57
58 .B MBK_SPI_MERGE
59
60 .B MBK_SPI_FILE
61 .RE
62
63 .SH ENVIRONMENT VARIABLES
64
65 .B MBK_SPI_TP
66
67 .B MBK_SPI_TN
68
69 Transistor model name. Multiple names may be concatened using the character ':'. Default names are
70 .I tp
71 and
72 .I tn
73
74 .B MBK_SPI_NETNAME
75
76 Comment used to name the nodes. Default is
77 .I NET.
78
79 .B MBK_SPI_SEPAR
80
81 Character used to separate a name from a node number on the interface of the \fB.SUBCKT\fP. The parser considers nodes of the same name to be on the same equipotential. Default is '\fB.\fP'.
82
83 .B MBK_SPI_MERGE
84
85 If this variable is set, the parser does not merge interface nodes of the same name, but different number, on the same equipotential.
86
87 .B MBK_SPI_FILE
88
89 If this variable is set, the name of the files opened are displayed on the error output.
90
91 .SH EXAMPLE
92
93 This is an example of a file used by the Spice parser.
94
95 .nf
96
97 .INCLUDE mx2_y.spi
98 .INCLUDE ndrvp_y.spi
99
100 .subckt gxor 24 42 49 52 53 61 54 63 64 71 72
101 * NET 1 = implicit
102 * NET 4 = auxsc1
103 * NET 13 = auxsc3
104 * NET 26 = a
105 * NET 40 = b
106 * NET 49 = s
107 * NET 52 = vdd
108 * NET 65 = vss
109 xauxsc1 64 65 53 55 33 35 2 8 ndrvp_y
110 xs 66 70 56 60 48 50 11 21 5 9 34 36 38 45 mx2_y
111 xauxsc3 70 71 60 61 41 46 18 22 ndrvp_y
112 R2_1 4 7 6
113 C2_11 4 63 6.9e-15
114 C2_12 7 63 6.9e-15
115 R2_2 3 2 0.15
116 C2_21 3 63 7.2e-16
117
118 .B [----- CUT -----]
119
120 C4_51 69 63 6.525e-15
121 C4_52 72 63 6.525e-15
122 R4_6 68 69 0.001
123 R4_7 68 67 0.001
124 .ends gxor
125
126 .SH SEE ALSO
127
128 .B tas(1) yagle(1)
129
130 .so man1/avt_bug_report.1