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 | ###############################################################################
# Copyright (c) 2017-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
# Wrap Top Modules
# @namespace
# WrapTops
# @section
# Modify the Loaded Database
# @description
# Add a main menu entry to create a wrapper module that instantiates all
# top cells in an artificial new top module.
# @configuration
# @files
# wrapTops.tcl
# @example
# demo/spice/asiclib.sp
# @cmdline
# -hspice @example[0]
# -userware @files[0]
# @tag
# zdb spice netlist rtl verilog
###############################################################################
# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc WrapTops:Init {} {
global WrapTops
##
# Set config options
#
gui plugin addConfig WrapTops createPorts 1 bool \
"Create top-level ports."
##
# On DB change, check if there's a wrapper module.
#
set WrapTops(isWrapped) 0
gui database runAndRegisterChangedCallback WrapTops:_updateState
##
# Add menu entries.
#
gui menu checkbutton {"Userware" "Wrap Tops"} [list WrapTops:Run] \
WrapTops(isWrapped)
}
# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc WrapTops:Finit {} {
##
# Undo modifications of the GUI.
#
gui menu removeEntry {"Userware" "Wrap Tops"}
##
# Remove callback.
#
gui database removeChangedCallback WrapTops:_updateState
}
# =============================================================================
# Run - Create a new top module and instantiate all previous tops.
# =============================================================================
#
proc WrapTops:Run {} {
global WrapTops
set db [gui database get]
if {$db == {}} {
zmessage print WAR "no db"
return
}
##
# collect names of current top cells
#
set tops {}
$db foreach top t {
lappend tops [$db oid oname $t]
}
if {$tops == {}} {
zmessage print WAR "no top cells"
return
}
WrapTops:_updateState $db
if {$WrapTops(isWrapped)} {
set toid [$db get_top_design]
set cells {}
$db foreach inst $toid i {
lappend cells [$db oid cname $i]
$db flag $i set zombie
}
$db deleteZombies
$db flag $toid set zombie
$db deleteZombies
foreach c $cells {
set mod [$db search module $c]
if {![$db oid isnull $mod]} {
$db top set $mod
}
}
set WrapTops(isWrapped) 0
gui database changed $db
return
}
set createPorts [gui plugin getConfigValue WrapTops createPorts]
##
# create wrapper module
#
set wrapper [WrapTops:_findUniqueCellName $db "wrapper"]
$db load module $wrapper
set wrapper_oid [$db search module $wrapper]
$db attr $wrapper_oid set "isWrapperModule=1"
##
# set it as the new top
#
$db oper deftop $wrapper_oid
##
# instantiate old tops
#
set insts {}
$db reloadModule $wrapper
foreach t $tops {
$db load inst $t $t -attr @name=
set ioid [$db search inst $wrapper_oid $t]
lappend insts $ioid
if {$createPorts} {
##
# create wrapper ports & connect them to the new instance
#
$db foreach pin $ioid p {
set pname [$db oid pname $p]
set pdir [$db directionOf $p]
$db load port $t:$pname $pdir -attr @name=$pname
$db load net $t:$pname -port $t:$pname -pin $t $pname
}
##
# create wrapper portBuses
#
$db foreach pinBus $ioid p {
set pname [$db oid pname $p]
set pdir [$db directionOf $p]
set pwid [$db widthOf $p]
set cmd "$db load portBus $t:$pname $pdir $pwid"
$db foreach pin $p m {
append cmd " $t:[$db oid pname $m]"
}
append cmd " -attr @name=$pname"
{*}$cmd
}
}
}
set WrapTops(isWrapped) 1
##
# inform gui about changes
#
gui database modified
##
# go to old tops
#
gui goto $insts
}
# -----------------------------------------------------------------------------
# _updateState - Check if there's a wrapper module.
# -----------------------------------------------------------------------------
#
proc WrapTops:_updateState {db} {
global WrapTops
if {$db == {}} {
set WrapTops(isWrapped) 0
return
}
set tops {}
$db foreach top t {
lappend tops [$db oid oname $t]
}
if {$tops == {}} {
set WrapTops(isWrapped) 0
return
}
if {[llength $tops] != 1} {
set WrapTops(isWrapped) 0
return
}
set toid {}
$db foreach top toid {
break
}
if {[$db attr $toid getValue "isWrapperModule"] == "1"} {
set WrapTops(isWrapped) 1
} else {
set WrapTops(isWrapped) 0
}
}
# -----------------------------------------------------------------------------
# _findUniqueCellName - Create a unique cell name by appending increasing
# indices to $base
# -----------------------------------------------------------------------------
#
proc WrapTops:_findUniqueCellName {db base} {
set name $base
set index 0
while {![$db oid isnull [$db search cell $name]]} {
incr index
set name "$base$index"
}
return $name
}
# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
WrapTops:Init
|