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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
###############################################################################
# Copyright (c) 2013-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.
# =============================================================================
#   @script
#       Userware script that reads in a force file.
###############################################################################


set forceList {}


# -----------------------------------------------------------------------------
# _getTop - Return top module of design
# -----------------------------------------------------------------------------
#
proc _getTop {db} {
    ##
    # Set the OID of the top level module.
    #
    set top {}
    $db foreach top t {
        if {$top == {}} {
            set top $t
        } else {
            zmessage print WAR "Multiple tops, using [$db oid oname $top]"
            break
        }
    }
    return $top
}


# -----------------------------------------------------------------------------
# _parseForce - Read the configuration from a file.
#               return list of driver pins and there values.
# -----------------------------------------------------------------------------
#
proc _parseForce {fname db top} {
    set result {}

    ##
    # Read the force file line by line
    #
    set lineNo 0
    set in [open $fname "r"]
    while {![eof $in]} {
        ##
        # Increment line number
        #
        incr lineNo

        ##
        # Get the next line in the file.
        #
        set line [string trim [gets $in]]

        ##
        # Ignore empty lines
        #
        if {$line == {}} {
            continue
        }

        ##
        # Parse only lines starting with the keyword 'force' and
        # end with a semicolon.
        #
        if {![string match "force *=*;" $line]} {
            zmessage print WAR "Wrong syntax in line: '$line'" $fname $lineNo
            continue
        }

        ##
        # Remove keyword 'force' and the semicolon at the end.
        #
        set line [string trim [string range $line 6 end-1]]

        ##
        # Parse lines like: "force block.foo_reg[1] = 1;"
        #
        set fields [split $line "="]
        set name   [string trim [lindex $fields 0]]
        set value  [string trim [lindex $fields 1]]
        if {$name == ""} {
            zmessage print WAR "Name missing" $fname $lineNo
            continue
        }
        if {$value == ""} {
            zmessage print WAR "value missing" $fname $lineNo
            continue
        }
        if {($value != "0") && ($value != "1")} {
            zmessage print WAR \
                "value '$value' of '$name' invalid" $fname $lineNo
            continue
        }

        if {[string last "." $name] < 0} {
            zmessage print WAR "Cannot find '.' in '$name'" $fname $lineNo
            continue
        }

        zmessage print DBG \
            "force $name = $value"

        ##
        # Try to create a pin OID from this name.
        #
        if {[catch {
            set pin [$db oid createFromString pin $top $name . -delim .]
        } msg]} {
            zmessage print WAR $msg $fname $lineNo
            continue
        }

        ##
        # Add to result
        #
        lappend result $pin $value
    }
    return $result
}


# -----------------------------------------------------------------------------
# _processForcedDriver - Highlight forced drivers
# -----------------------------------------------------------------------------
#
proc _processForcedDriver {db} {
    global forceList

    foreach {pin value} $forceList {
        ##
        # Highlight driver register.
        #
        set dir [$db directionOf $pin]
        if {$dir != "output"} {
            continue
        }

        set inst [$db oid convertTo inst $pin]
        $db flathilight $inst set  3 ;# blue
    }
}


# -----------------------------------------------------------------------------
# _processForcedInput - Highlight forced drivers
# -----------------------------------------------------------------------------
#
proc _processForcedInput {db pin value} {
    ##
    # Mark active and inactive  pin
    # Because pin names are created by the RTL parser,
    # we need to look for well defined port indices.
    #
    set inst [$db oid convertTo inst $pin]
    set func [$db primFuncOf $inst]
    switch -- $func {
        "MUX" {
            set pno -1
            set d0  {}
            set d1  {}
            set sel {}
            set p   {}
            $db foreach pin $inst p {
                incr pno

                ##
                # 0=>o,  1=d0, 2=d1, 3=sel
                #
                switch $pno {
                    0 {}
                    1 {set d0  $p}
                    2 {set d1  $p}
                    3 {set sel $p}
                }
            }
            if {$p == $pin} {
                if {$value} {
                    set active   $d1
                    set inactive $d0
                } else {
                    set active   $d0
                    set inactive $d1
                }
                zmessage print DBG \
                    "value=$value active $active inactive $inactive"
                $db flathilight $inactive set 0 ;# red
                $db flathilight $active   set 1 ;# green
                $db flathilight $inst     set 9 ;# pink
            }
        }
        default {
            zmessage print WAR "Func $func at pin $pin not supported"
        }
    }
}


# -----------------------------------------------------------------------------
# _processForcedValues - Highlight forced MUXes
# -----------------------------------------------------------------------------
#
proc _processForcedValues {db} {
    global forceList

    foreach {pin value} $forceList {
        ##
        # Skip unconnected pins.
        #
        if {![$db isConnected $pin]} {
            continue
        }

        ##
        # Add the value as an attribute.
        #
        set net [$db connectedNet $pin]
        set signal [$db oid convertTo signal $net]

        $db flat foreach net $signal net {
            $db flatattr $net set value=$value
        }

        $db flat foreach pin $signal pin {
            $db flatattr $pin set value=$value
        }

        ##
        # Process all connected flat pins
        #
        $db flat foreach pin $signal pin {
            set dir [$db directionOf $pin]
            if {$dir != "input"} {
                continue
            }

            _processForcedInput $db $pin $value
        }
    }
}


# -----------------------------------------------------------------------------
# _loadCone -
# -----------------------------------------------------------------------------
#
proc _loadCone {connectedMux first} {
    global forceList

    set db [gui database get]
    set oids {}
    foreach {pin value} $forceList {
        ##
        # Skip unconnected pins.
        #
        if {![$db isConnected $pin]} {
            continue
        }

        ##
        # Get Signal
        #
        set net [$db connectedNet $pin]
        set signal [$db oid convertTo signal $net]

        if {$connectedMux} {
            ##
            # Look for connected MUX
            #
            set hasMux false
            $db flat foreach pin $signal p {
                set inst [$db oid convertTo inst $p]
                set func [$db primFuncOf $inst]
                if {$func != "MUX"} {
                    continue
                }
                set pname [$db oid pname $p]
                if {$pname != "sel"} {
                    continue
                }
                set hasMux true
                break
            }
            if {!$hasMux} {
                continue
            }

            ##
            # Get all connected flat pins
            #
            $db flat foreach pin -addHier $signal p {
                lappend oids $p
            }
        } else {
            $db flat foreach pin $signal p {
                set inst [$db oid convertTo inst $p]
                set func [$db primFuncOf $inst]
                if {$func != "MUX"} {
                    continue
                }
                set pname [$db oid pname $p]
                if {$pname != "sel"} {
                    continue
                }
                lappend oids $inst
            }
        }

        if {$first && ($oids != {})} {
            break
        }
    }

    ##
    # Load cone
    #
    gui cone load $oids
    gui window show Cone
}


# -----------------------------------------------------------------------------
# _doAll - Call everything needed
# -----------------------------------------------------------------------------
#
proc _doAll {db forceFile inGui} {
    global forceList

    ##
    # Return if the database is empty.
    #
    if {$db == {}} {
        return
    }

    set top [_getTop $db]

    set forceList [_parseForce $forceFile $db $top]
    _processForcedDriver $db
    _processForcedValues $db
    if {$inGui} {
        gui highlight changed
        gui attribute changed
    }
}


# -----------------------------------------------------------------------------
# _getForceFile - Start from userware menu
# -----------------------------------------------------------------------------
#
proc _getForceFile {} {
    set forceFile [gui window fileDialog openFile "Force File" {{"Force" {.v}}}]
    if {$forceFile == {}} {
        return
    }

    _doAll [gui database get] $forceFile true
}


# -----------------------------------------------------------------------------
# _updateMenu - add menu entries for loading cone
# -----------------------------------------------------------------------------
#
proc _updateMenu {menuId} {
    global forceList

    set db [gui database get]
    if {($db == {}) || ($forceList == {})} {
        $menuId entryconfigure end -state disabled
    } else {
        $menuId entryconfigure end -state normal
    }
}


# -----------------------------------------------------------------------------
# _extendUserwareMenu - add menu entries for loading cone
# -----------------------------------------------------------------------------
#
proc _extendUserwareMenu {} {
    gui menu command   {"Userware" "Load Force File"} {_getForceFile}
    gui menu separator {"Userware"}
    gui menu command   {"Userware" "1st Mux only"} \
                       [list _loadCone false true]
    gui menu command   {"Userware" "All Mux only"} \
                       [list _loadCone false false]
    gui menu command   {"Userware" "1st Mux and Connect"} \
                       [list _loadCone true true]
    gui menu command   {"Userware" "All Mux and Connect"} \
                       [list _loadCone true false]
    gui menu customizeEntry {"Userware" "1st Mux only"}        _updateMenu
    gui menu customizeEntry {"Userware" "All Mux only"}        _updateMenu
    gui menu customizeEntry {"Userware" "1st Mux and Connect"} _updateMenu
    gui menu customizeEntry {"Userware" "All Mux and Connect"} _updateMenu
}


# -----------------------------------------------------------------------------
# Check different ways to run this script.
# -----------------------------------------------------------------------------
#
if {$argc == 0} {
    ##
    # Extend userware menu
    #
    _extendUserwareMenu
} elseif {$argc == 1} {
    ##
    # Run in the GUI as '-userware2'.
    #
    _extendUserwareMenu
    set forceFile [lindex $argv 0]
    _doAll [gui database get] $forceFile false
} elseif {$argc == 2} {
    ##
    # Run in a 'zdbsh'.
    #
    set forceFile [lindex $argv 0]
    set binfile   [lindex $argv 1]
    set db [zdb open $binfile]
    _doAll $db $forceFile false
} else {
    error "Wrong number of args."
}