1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302 | ###############################################################################
# Copyright (c) 2015-2024 by Altair Engineering, Inc.
# All rights reserved.
#
# Altair Engineering, Inc. makes this software available as part of the Vision
# tool platform. As long as you are a licensee of the Vision tool platform
# you may make copies of the software and modify it to be used within the
# Vision tool platform, but you must include all of this notice on any copy.
# Redistribution without written permission to any third party, with or
# without modification, is not permitted.
# Altair Engineering, Inc. does not warrant that this software is error free
# or fit for any purpose. Altair Engineering, Inc. disclaims any liability for
# all claims, expenses, losses, damages and costs any user may incur as a
# result of using, copying or modifying the software.
# =============================================================================
# @plugin
# Display Voltage
# @namespace
# DisplayVoltage
# @section
# Miscellaneous Userware Examples
# @description
# Display the voltages in the given file at the nets.
# @files
# cust26/displayVoltage.tcl
# cust26/ram2k.ic
# @example
# demo/spice/ram2k.sp
# @cmdline
# -userware2 @files[0] @files[1]
# -hspice @example[0]
# @tag
# spice
###############################################################################
# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc DisplayVoltage:Init {argc argv} {
global DisplayVoltage
##
# If args are given run non-interactive.
#
set DisplayVoltage(callbackRegistered) 0
if {$argc == 1} {
gui database registerChangedCallback \
"DisplayVoltage:_readVoltageFile [lindex $argv 0]"
set DisplayVoltage(callbackRegistered) 1
}
##
# Display net attributes only at the wire, not at the connected pin.
#
set DisplayVoltage(nlv:netattrwire) [gui settings get "nlv:netattrwire"]
set DisplayVoltage(nlv:netattrpin) [gui settings get "nlv:netattrpin"]
gui settings set "nlv:netattrwire" 1
gui settings set "nlv:netattrpin" 0
gui settings changed
##
# Add a new main menu entry 'Debug' to access the procedure of this script.
#
gui menu command \
{"Debug" "Load Voltage File"} \
{DisplayVoltage:_readVoltageFile}
}
# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc DisplayVoltage:Finit {} {
global DisplayVoltage
##
# Reset global settings.
#
if {[info exists DisplayVoltage(nlv:netattrpin)]} {
gui settings set "nlv:netattrpin" $DisplayVoltage(nlv:netattrpin)
}
if {[info exists DisplayVoltage(nlv:netattrwire)]} {
gui settings set "nlv:netattrwire" $DisplayVoltage(nlv:netattrwire)
}
gui settings changed
gui menu removeEntry {"Debug" "Load Voltage File"}
if {$DisplayVoltage(callbackRegistered)} {
gui database removeChangedCallback "DisplayVoltage:_readVoltageFile"
set DisplayVoltage(callbackRegistered) 0
}
array unset DisplayVoltage
}
# -----------------------------------------------------------------------------
# _readVoltageFile - Read the voltage file and store all found net names and
# corresponding values in a hash table.
# -----------------------------------------------------------------------------
#
proc DisplayVoltage:_readVoltageFile {{fname ""} {db {}}} {
##
# First check if a database is available (netlist is loaded).
#
set db [gui database get]
if {$db == {}} {
zmessage print WAR "No database loaded."
return
}
##
# If the given file name is empty then show an open file dialog to browse
# for an input file.
#
if {$fname == ""} {
set ftype {{"Voltage File" ".ic"}}
set fname [gui window fileDialog openFile "Open a Voltage File" $ftype]
}
##
# Return from this procedure if the file name is still empty.
#
if {($fname == "") || (![file exists $fname])} {
return
}
##
# Open the voltage file for reading.
#
set in [open $fname rb]
##
# Initialize used variables.
#
array set _vmap {}
set begin 0
##
# Read the Voltage file line by line.
#
while {![eof $in]} {
##
# Get the next line.
#
set line [string trim [gets $in]]
##
# Check for 'BEGIN' and 'END' entries in the file.
#
if {[string match "* BEGIN: *" $line]} {
set begin 1
}
if {[string match "* END: *" $line]} {
set begin 0
}
##
# Skip all lines not between a 'BEGIN' and 'END' section.
#
if {$begin == 0} {
continue
}
##
# Skip all lines that do not contain the pattern "* v(*) = *".
#
if {![string match "* v(*) = *" $line]} {
continue
}
##
# Extract the net names and the voltage values from the current line.
# For each net add an entry to the _vmap hash table.
#
foreach {name value} [split $line "="] {
set from [string first "v(" $name]
set to [string first ")" $name]
set name [string range $name $from+2 $to-1]
set value [string trim $value]
set _vmap($name) $value
}
}
##
# Close the input file.
#
close $in
##
# Call '_displayVoltage' to add display attributes
#
DisplayVoltage:_displayVoltage $db _vmap
}
# -----------------------------------------------------------------------------
# _displayVoltage - Add attributes to the database containing the voltage
# value for all nodes entered into the hash table given
# by its name.
# -----------------------------------------------------------------------------
#
proc DisplayVoltage:_displayVoltage {db vmapName} {
##
# Access net name and voltage value array one level above.
#
upvar 1 $vmapName _vmap
##
# First search for all global flagged nodes.
#
array set _globalNodes {}
##
# Loop over all database modules (sub-circuits).
#
$db foreach module module {
##
# Inside each module loop over all nets.
#
$db foreach net $module net {
##
# Check if the net is flagged as a global net.
#
if {![$db flag $net is global]} {
continue
}
##
# Get the net name.
#
set netName [$db oid oname $net]
##
# Check if this net is entered in the _vmap table.
#
if {[info exists _vmap($netName)]} {
##
# Add the '#VOLTAGE' attribute to the global node.
#
$db attr $net set "#VOLTAGE=$_vmap($netName)"
##
# Remember all global nets.
#
set _globalNodes($netName) 1
}
}
}
##
# Remove already processed global nets from the _vmap table.
#
foreach netName [array names _globalNodes] {
array unset _vmap $netName
}
##
# Loop over all remaining nets in _vmap.
#
foreach {name value} [array get _vmap] {
##
# Get the OID of the net.
#
set net [$db get_net -hiersep . $name]
##
# Show an error if the net could not be found.
#
if {[$db oid isnull $net]} {
zmessage print ERR "Net '$name' could not be found."
continue
}
##
# Add the flat '#VOLTAGE' attribute to the net.
#
$db flatattr $net set "#VOLTAGE=$value"
}
##
# Make the '#VOLTAGE' attribute visible.
#
$db attr -db set @nlv:net=%{#VOLTAGE}V
##
# Inform the GUI about changed attributes.
#
gui attribute changed
}
# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
DisplayVoltage:Init $argc $argv
|