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
###############################################################################
# Copyright (c) 2018-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
#       Merge Serial Verilog Resistors
#   @namespace
#       MergeSerialVeriRes
#   @section
#       Modify the Loaded Database
#   @description
#       Replace all modules matching any of the given name patterns in the
#       provided side file as a resistor device. Then merge all serial
#       resistor devices.
#   @license
#       permit spice
#   @files
#       cust27/mergeSerialVeriRes.tcl
#   @example
#       demo/api/cust27/mergeSerialVeriRes.v
#       demo/api/cust27/mergeSerialVeriRes.txt
#   @cmdline
#       -verilog @example[0]
#       -userware2 @files[0] @example[1]
#   @tag
#       netlist verilog
###############################################################################


# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc MergeSerialVeriRes:Init {argv} {
    global MergeSerialVeriRes

    ##
    # Add menu entry.
    #
    gui menu command {"Userware" "Load MergeSerialVeriRes Config"} \
        [list MergeSerialVeriRes:Start true]

    ##
    # Get the name of the configuration file.
    #
    set MergeSerialVeriRes(configFile) [lindex $argv 0]

    ##
    # Install callback and run it immediately if there already is a database.
    #
    gui database runAndRegisterChangedCallback \
        [list MergeSerialVeriRes:Start false]
}


# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc MergeSerialVeriRes:Finit {} {
    ##
    # Undo modifications of the GUI.
    #
    gui menu removeEntry {"Userware" "Load MergeSerialVeriRes Config"}

    ##
    # Remove the database changed callback.
    #
    gui database removeChangedCallback MergeSerialVeriRes:Start
}


# =============================================================================
# Start -
# =============================================================================
#
proc MergeSerialVeriRes:Start {interactive {db {}}} {
    global MergeSerialVeriRes

    ##
    # Get the database handle and return of no database is available.
    #
    if {$db == {}} {
        set db [gui database get]
        if {$db == {}} {
            return
        }
    }

    ##
    # If running interactively, then show a file open dialog to browse
    # for a configuration file.
    #
    if {$interactive} {
        set MergeSerialVeriRes(configFile) [gui window fileDialog openFile \
                "Open a Config file" \
                {{"MergeSerialVeriRes-Config" {".txt"}}}]
    }

    ##
    # Return from this procedure if no configuration file is set.
    #
    if {($MergeSerialVeriRes(configFile) eq "")          ||
        (![file exists $MergeSerialVeriRes(configFile)])} \
    {
        return
    }

    ##
    # Rear the configuration file and store the values.
    #
    set in [open $MergeSerialVeriRes(configFile) rb]
    while {![eof $in]} {
        gets $in line

        set resModuleNamePattern [string trim [lindex $line 0]]
        if {$resModuleNamePattern eq ""} {
            continue
        }
        if {[string match "#*" $resModuleNamePattern]} {
            continue
        }

        set key "resValueNames:$resModuleNamePattern"
        set MergeSerialVeriRes($key) {}
        foreach nameMap [lrange $line 1 end] {
            lappend MergeSerialVeriRes($key) $nameMap
        }
    }
    close $in

    ##
    # Loop over the database and find instances of modules matching any of the
    # resistor patterns given in the configuration file.
    #
    $db flag -db clear red
    set resModuleFound false
    $db foreach module module {
        set moduleName [$db oid oname $module]
        foreach namePattern [array names MergeSerialVeriRes "resValueNames:*"] {
            set pattern [string range $namePattern 14 end]
            if {[string match $pattern $moduleName]} {
                $db flag $module set leafcell
                $db flag $module set red
                set attrNameMap $MergeSerialVeriRes($namePattern)
                $db attr $module set "@attrNameMap=$attrNameMap"
                set resModuleFound true
                break
            }
        }
    }

    ##
    # Return if no module matching a resistor pattern was found.
    #
    if {!$resModuleFound} {
        return
    }

    ##
    # Set all flagged resistor modules as primitives.
    #
    $db setPrimitive -flag

    ##
    # Load one resistor primitive.
    #
    $db load primitive "_VERI_RES_" RES
    $db load port pos inout
    $db load port neg inout

    ##
    # Loop over the database and find instances of modules matching any of the
    # resistor patterns given in the configuration file.
    #
    $db foreach module module {
        $db foreach inst $module inst {
            set cellRef [$db down $inst]
            if {[$db flag $cellRef is red]} {
                foreach attrName [$db attr $cellRef getValue "@attrNameMap"] {
                    set resValue [$db attr $inst getValue $attrName]
                    if {$resValue ne ""} {
                        $db attr $inst set R=$resValue
                        break
                    }
                }
                $db oper changecellref $inst "_VERI_RES_"
            }
        }
    }
    $db oper changecellref -updateOIDs
    $db oper mergeSerialRes -delzombies
    gui database modified
}


# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
MergeSerialVeriRes:Init $argv