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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
###############################################################################
# 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.
# =============================================================================
#   @plugin
#       Create UNISIM Symbols
#   @namespace
#       UnisimSymbols
#   @section
#       Analyze the Loaded Database
#   @description
#       Create symbols for cells with UNISIM-style names.
#
#       The function is activated by the new main menu entry
#       `Userware > UNISIM Symbols`.
#   @license
#       permit verilog
#   @files
#       createUnisimSymbols.tcl
#   @example
#       demo/edif/gl85.edf
#   @cmdline
#       -edif @example[0]
#       -userware @files[0]
#   @tag
#       zdb fpga netlist
###############################################################################


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

    gui menu command {"Userware" "UNISIM Symbols"} UnisimSymbols:Run

    set UnisimSymbols(table) {
        "AND"
        "UnisimSymbols:_bool AND"

        "AUTOBUF"
        "UnisimSymbols:_sym BUF {}"

        "BSCAN"
        "UnisimSymbols:_sym GEN {}"

        "BIBUF"
        "UnisimSymbols:_sym GEN {}"

        "BUFE"
        "UnisimSymbols:_sym BUFIF1 {E .top}"

        "BUFGCE"
        "UnisimSymbols:_sym BUFIF1 {CE .top}"

        "BUFGCTRL"
        "UnisimSymbols:_sym GEN {}"

        "BUFGMUX"
        "UnisimSymbols:_sym GEN {}"

        "BUFGH"
        "UnisimSymbols:_sym GEN {}"

        "BUFIODQS"
        "UnisimSymbols:_sym GEN {}"

        "BUFIO2"
        "UnisimSymbols:_sym GEN {}"

        "BUFPLL"
        "UnisimSymbols:_sym GEN {}"

        "BUFR"
        "UnisimSymbols:_sym GEN {}"

        "BUFT"
        "UnisimSymbols:_sym GEN {}"

        "BUF"
        "UnisimSymbols:_sym BUF {}"

        "CAPTURE"
        "UnisimSymbols:_sym BUF {CLK .clk}"

        "CARRY4"
        "UnisimSymbols:_sym GEN {CI .bot}"

        "CFGLUT"
        "UnisimSymbols:_sym GEN {CLK .clk}"

        "CLKDLL"
        "UnisimSymbols:_sym GEN {CLKIN .clk CLKFB .clk}"

        "CLK_DIV"
        "UnisimSymbols:_sym GEN {CLKIN .clk}"

        "CONFIG"
        "UnisimSymbols:_sym GEN {}"

        "CRC"
        "UnisimSymbols:_sym GEN {CRCCLK .clk CRCRESET .bot}"

        "DCIRESET"
        "UnisimSymbols:_sym GEN {}"

        "DCM"
        "UnisimSymbols:_sym GEN {CLKIN .clk CLKFB .clk RST .bot}"

        "DNA"
        "UnisimSymbols:_sym GEN {CLK .clk}"

        "DSP"
        "UnisimSymbols:_sym GEN {CLK .clk}"

        "EFUSE"
        "UnisimSymbols:_sym GEN {}"

        "EMAC"
        "UnisimSymbols:_sym GEN {}"

        "FD"
        "UnisimSymbols:_sym GEN {C .clk PRE .top CLR .bot S .top R .bot}"

        "FJ"
        "UnisimSymbols:_sym GEN {C .clk PRE .top CLR .bot S .top R .bot}"

        "FIFO"
        "UnisimSymbols:_sym GEN {RDCLK .clk WRCLK .clk RST .bot}"

        "FMAP"
        "UnisimSymbols:_sym GEN {}"

        "FRAME"
        "UnisimSymbols:_sym GEN {}"

        "FTC"
        "UnisimSymbols:_sym GEN {C .clk CLR .bot}"

        "FTP"
        "UnisimSymbols:_sym GEN {C .clk PRE .top}"

        "GND"
        "UnisimSymbols:_sym GEN {G .top}"

        "GT1"
        "UnisimSymbols:_sym GEN {DCLK .clk REFCLK .clk DEN .bot}"

        "GTH"
        "UnisimSymbols:_sym GEN {DCLK .clk REFCLK .clk DEN .bot}"

        "GTP"
        "UnisimSymbols:_sym GEN {DCLK .clk REFCLK .clk DEN .bot}"

        "GTX"
        "UnisimSymbols:_sym GEN {DCLK .clk REFCLK .clk DEN .bot}"

        "GTZ"
        "UnisimSymbols:_sym GEN {CFGCLK .clk DEN .bot}"

        "IBUFDS_LVS"
        "UnisimSymbols:_sym GEN {}"

        "IBUFDS_DLY"
        "UnisimSymbols:_sym GEN {}"

        "IBUFDS_DIFF"
        "UnisimSymbols:_sym GEN {}"

        "IBUFDS_DIS"
        "UnisimSymbols:_sym GEN {}"

        "IBUFDS_INTERM"
        "UnisimSymbols:_sym GEN {}"

        "IBUFDS_GT"
        "UnisimSymbols:_sym GEN {}"

        "IBUFDS"
        "UnisimSymbols:_sym GEN {}"

        "IBUFGDS"
        "UnisimSymbols:_sym GEN {}"

        "IBUF_DLY"
        "UnisimSymbols:_sym GEN {}"

        "IBUF_IBUF_DIS"
        "UnisimSymbols:_sym GEN {}"

        "IBUF_INTERM"
        "UnisimSymbols:_sym GEN {}"

        "IBUF"
        "UnisimSymbols:_sym BUF {}"

        "IOBUF"
        "UnisimSymbols:_sym BUF {}"

        "ICAP"
        "UnisimSymbols:_sym GEN {CLK .clk}"

        "IDDR"
        "UnisimSymbols:_sym GEN {C .clk S .top R .bot}"

        "IDELAY"
        "UnisimSymbols:_sym GEN {C .clk RST .bot}"

        "IFDDR"
        "UnisimSymbols:_sym GEN {PRE .top CLR .bot}"

        "ILD"
        "UnisimSymbols:_sym GEN {}"

        "INV"
        "UnisimSymbols:_sym INV {}"

        "IN_FIFO"
        "UnisimSymbols:_sym GEN {RDCLK .clk WRCLK .clk RESET .bot}"

        "IODELAY"
        "UnisimSymbols:_sym GEN {C .clk RST .bot}"

        "IODRP2"
        "UnisimSymbols:_sym GEN {CLK .clk BRST .bot}"

        "ISERDES"
        "UnisimSymbols:_sym GEN {CLK .clk CLKDIV .clk OCLK .clk RST .bot}"

        "JTAG"
        "UnisimSymbols:_sym GEN {}"

        "KEEP"
        "UnisimSymbols:_sym GEN {}"

        "KEY_CLEAR"
        "UnisimSymbols:_sym GEN {}"

        "LD"
        "UnisimSymbols:_sym GEN {PRE .top CLR .bot}"

        "LUT"
        "UnisimSymbols:_sym GEN {}"

        "MCB"
        "UnisimSymbols:_sym GEN {}"

        "MERGE"
        "UnisimSymbols:_sym GEN {}"

        "MIN_OFF"
        "UnisimSymbols:_sym GEN {}"

        "MMCM"
        "UnisimSymbols:_sym GEN {PSCLK .clk RST .bot}"

        "MULT"
        "UnisimSymbols:_sym GEN {}"

        "MUX"
        "UnisimSymbols:_sym GEN {}"

        "NAND"
        "UnisimSymbols:_bool NAND"

        "NOR"
        "UnisimSymbols:_bool NOR"

        "OBUFT"
        "UnisimSymbols:_sym GEN {}"

        "OBUFDT"
        "UnisimSymbols:_sym GEN {}"

        "OBUFDS"
        "UnisimSymbols:_sym GEN {}"

        "OBUFE"
        "UnisimSymbols:_sym GEN {}"

        "OBUF"
        "UnisimSymbols:_sym BUF {}"

        "ODDR"
        "UnisimSymbols:_sym GEN {C .clk S .top R .bot}"

        "ODELAYE2"
        "UnisimSymbols:_sym GEN {C .clk}"

        "OFDDR"
        "UnisimSymbols:_sym GEN {PRE .top CLR .bot}"

        "OPT"
        "UnisimSymbols:_sym GEN {}"

        "ORCY"
        "UnisimSymbols:_sym GEN {}"

        "OR"
        "UnisimSymbols:_bool OR"

        "OSERDES"
        "UnisimSymbols:_sym GEN {CLK .clk}"

        "OUT_FIFO"
        "UnisimSymbols:_sym GEN {RDCLK .clk WRCLK .clk RESET .bot}"

        "PCIE"
        "UnisimSymbols:_sym GEN {DRPCLK .clk PIPECLK .clk USERCLK .clk}"

        "PHASER"
        "UnisimSymbols:_sym GEN {}"

        "PHY_CONTROL"
        "UnisimSymbols:_sym GEN {MEMREFCLK .clk PHYCLK .clk RESET .bot}"

        "PLL"
        "UnisimSymbols:_sym GEN {DCLK .clk RST .bot}"

        "PMCD"
        "UnisimSymbols:_sym GEN {DCLK .clk RST .bot}"

        "POST_CRC_INTERNAL"
        "UnisimSymbols:_sym GEN {}"

        "PPC"
        "UnisimSymbols:_sym GEN {}"

        "PS7"
        "UnisimSymbols:_sym GEN {}"

        "PULLDOWN"
        "UnisimSymbols:_sym PULLDOWN {}"

        "PULLUP"
        "UnisimSymbols:_sym PULLUP {}"

        "RAM"
        "UnisimSymbols:_sym GEN {CLK .clk CLKA .clk CLKB .clk WCLK .clk}"

        "ROM"
        "UnisimSymbols:_sym GEN {}"

        "SIM"
        "UnisimSymbols:_sym GEN {CCLK .clk}"

        "SPI_ACCESS"
        "UnisimSymbols:_sym GEN {CLK .clk}"

        "SRL"
        "UnisimSymbols:_sym GEN {CLK .clk}"

        "STARTUP"
        "UnisimSymbols:_sym GEN {CLK .clk}"

        "SUSPEND_SYNC"
        "UnisimSymbols:_sym GEN {CLK .clk}"

        "SYSMON"
        "UnisimSymbols:_sym GEN {DCLK .clk RESET .bot}"

        "TBLOCK"
        "UnisimSymbols:_sym GEN {}"

        "TEMAC"
        "UnisimSymbols:_sym GEN {HOSTCLK .clk}"

        "TIMEGRP"
        "UnisimSymbols:_sym GEN {}"

        "TIMESPEC"
        "UnisimSymbols:_sym GEN {}"

        "USR_ACCES"
        "UnisimSymbols:_sym GEN {}"

        "VCC"
        "UnisimSymbols:_sym GEN {G .bot}"

        "WIREAND"
        "UnisimSymbols:_sym GEN {}"

        "XADC"
        "UnisimSymbols:_sym GEN {DCLK .clk RESET .bot}"

        "XNOR"
        "UnisimSymbols:_bool XNOR"

        "XOR"
        "UnisimSymbols:_bool XOR"

        "ZHOLD_DELAY"
        "UnisimSymbols:_sym GEN {}"
    }
}


# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc UnisimSymbols:Finit {} {
    gui menu removeEntry {"Userware" "UNISIM Symbols"}
}


# =============================================================================
# Run - Change symbol shape of all cells with UNISIM-style names.
# =============================================================================
#
proc UnisimSymbols:Run {} {
    global UnisimSymbols

    set db [gui database get]
    if {$db == {}} {
        return
    }

    set total   0
    set matched 0
    $db foreach cell cell {
        incr total

        set cellName [$db oid oname $cell]
        set match 0
        foreach {prefix func} $UnisimSymbols(table) {
            if {![string match "*$prefix*" $cellName]} {
                continue
            }
            set match [{*}$func $db $cell]
            incr matched
            break
        }

        if {!$match} {
            gui console print "Could not generate symbol for cell: '$cellName'."
        } else {
            gui console print "Generated symbol for cell: '$cellName'."
        }
    }

    gui console print "Created symbols for $matched/$total cells."

    if {$matched > 0} {
        gui database modified
    }
}


# -----------------------------------------------------------------------------
# _sym - Make a generic symbol.
#        type is nlvtype like GEN, BUF, INV, AND
#        pinList contains pinName/attribute pairs for pins like {"C" ".clk"}
# -----------------------------------------------------------------------------
#
proc UnisimSymbols:_sym {type pinList db cell} {
    if {[llength $pinList] > 0} {
        array set pins $pinList
    }
    set sym $type
    set clk 0
    $db foreach portBus $cell pbus {
        set pname [$db oid oname   $pbus]
        set dir   [$db directionOf $pbus]
        if {[info exists pins($pname)]} {
            set opt $pins($pname)
            append dir $opt
        }
        lappend sym pbus $pname $dir
        lappend sym [$db widthOf $pbus]
        $db foreach port $pbus sport {
            set pname [$db oid oname $sport]
            lappend sym $pname
        }
    }
    $db foreach port $cell port {
        if {[$db isBusMember $port]} {
            continue
        }
        set pname [$db oid oname   $port]
        set dir   [$db directionOf $port]
        if {[info exists pins($pname)]} {
            set opt $pins($pname)
            append dir $opt
            if {$opt == ".clk"} {
                set clk 1
                $db flag $port set clock
            }
        }
        lappend sym port $pname $dir
    }
    $db attr $cell set "@symbol=$sym"
    if {$clk} {
        $db flag $cell set clock
    }
    return 1
}


# -----------------------------------------------------------------------------
# _digitsPrefix - Get the int of a string.
# -----------------------------------------------------------------------------
#
proc UnisimSymbols:_digitsPrefix {str} {
    set width ""
    set isInt 1
    for {set pos 0} {$isInt && ($pos < [string length $str])} {incr pos} {
        set char  [string index $str $pos]
        set isInt [string is integer $char]
        if {$isInt} {
            append width $char
        }
    }
    return $width
}


# -----------------------------------------------------------------------------
# _bool - Make a Boolean gate symbol.
# -----------------------------------------------------------------------------
#
proc UnisimSymbols:_bool {boolType db cell} {
    set name   [$db oid oname $cell]
    set len    [string length $boolType]
    set suffix [string range $name $len end]

    set width  [UnisimSymbols:_digitsPrefix $suffix]

    incr len   [string length $width]
    set sep    [string range $name $len $len]

    if {$sep == "B"} {
        incr len
        set suffix [string range $name $len end]
        set bubble [UnisimSymbols:_digitsPrefix $suffix]
    } else {
        set bubble 0
    }

    set pinList {}
    set i 0
    $db foreach port $cell port {
        set pname [$db oid oname $port]
        set dir   [$db directionOf $port]
        if {$dir != "input"} {
            continue
        }
        if {$i >= $bubble} {
            break
        }
        lappend pinList $pname .neg
        incr i
    }
    return [UnisimSymbols:_sym $boolType $pinList $db $cell]
}


# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
UnisimSymbols:Init