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 | ###############################################################################
# Copyright (c) 2007-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
# Dump I/O Ports
# @namespace
# DumpIO
# @section
# Create Reports
# @description
# Add a main menu entry to loop over all modules and dump the I/O ports
# to a text file.
# @test
# ModuleTest
# @configuration
# @files
# dumpIO.tcl
# @example
# demo/rtl/aquarius/aquarius.f
# @cmdline
# -F @example[0]
# -userware @files[0]
# @tag
# gui zdb report
###############################################################################
# =============================================================================
# Init - Initialize the DumpIO plugin.
# =============================================================================
#
proc DumpIO:Init {} {
##
# Apply default configuration.
#
gui plugin addConfig DumpIO outFile "dumpIO.txt" text "The output file."
##
# Add a menu entry.
#
gui menu command {"Userware" "Dump I/O Ports to a File"} \
[list DumpIO:StartMenu]
##
# Use gui database runOrRegisterChangedCallback to immediately run dumpIO
# if we have a database, or otherwise register the proc to be executed
# after the database is available.
#
gui database runOrRegisterChangedCallback [list DumpIO:Start ""]
}
# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc DumpIO:Finit {} {
##
# Undo modifications of the GUI.
#
gui menu removeEntry {"Userware" "Dump I/O Ports to a File"}
##
# Remove the callback registration.
#
gui database removeChangedCallback "DumpIO:Start"
}
# =============================================================================
# StartMenu - Start DumpIO from the menu entry.
# =============================================================================
#
proc DumpIO:StartMenu {} {
set outFile [gui window fileDialog saveFile \
"DumpIO outFile" {{"Dump File" .txt}}]
if {$outFile != ""} {
DumpIO:Start $outFile [gui database get]
}
}
# =============================================================================
# Start - Loop over all modules and dump the I/O ports to a text file.
# =============================================================================
#
proc DumpIO:Start {outFile db} {
##
# Return if the database is empty.
#
if {$db == {}} {
return
}
##
# Get the outFile configuration.
#
if {$outFile == ""} {
set outFile [gui plugin getConfigValue DumpIO outFile]
}
##
# Open the output file for writing.
#
set out [open $outFile w]
##
# Process all tops.
#
array set _tops {}
$db foreach top top {
set name [$db oid oname $top]
set _tops($name) 1
puts $out "Top: $name"
DumpIO:_processModule $out $db $top
}
##
# Process all modules.
#
$db foreach module mod {
set name [$db oid oname $mod]
if {[info exists _tops($name)]} {
##
# Skip top modules.
#
continue
}
puts $out "Module: $name"
DumpIO:_processModule $out $db $mod
}
close $out
}
# -----------------------------------------------------------------------------
# _processModule - Process one module: dump all I/O ports to a file.
# -----------------------------------------------------------------------------
#
proc DumpIO:_processModule {out db mod} {
##
# Initialize hash tables.
#
array set _portBuses {}
array set _ports {}
##
# Collect I/O portBuses and ports of $mod into the _portBuses/_ports tables.
#
$db foreach portBus $mod bus {
set dir [$db directionOf $bus]
##
# Append the bus range or with to the bus name.
#
set name [$db oid oname $bus]
if {[$db hasRange $bus]} {
append name \[[$db rangeMsb $bus]:[$db rangeLsb $bus]\]
} else {
append name ([$db widthOf $bus])
}
lappend _portBuses($dir) $name
}
$db foreach port $mod port {
if {[$db isBusMember $port]} {
##
# Skip bus members, as we have already collected all buses.
#
continue
}
set dir [$db directionOf $port]
set name [$db oid oname $port]
lappend _ports($dir) $name
}
##
# Dump I/O ports grouped by direction.
#
foreach dir {output inout input unknown} {
##
# Print sorted portBuses first.
#
if {[info exists _portBuses($dir)]} {
foreach name [lsort -dictionary $_portBuses($dir)] {
puts $out " $dir $name"
}
}
##
# Print sorted ports.
#
if {[info exists _ports($dir)]} {
foreach name [lsort -dictionary $_ports($dir)] {
puts $out " $dir $name"
}
}
}
puts $out ""
}
# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
DumpIO:Init
|