cust33/reportSignalInformation.tcl

 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
###############################################################################
# Copyright (c) 2020-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.
# =============================================================================
#   @userware
#       Report Signal Information
#   @section
#       Create Reports
#   @description
#       Example Tcl script that uses ZDB API commands to report all signals with
#       the type (input, output, wire, reg, logic type of every electrical
#       connection, sequential and combinational logic).
#       Usage:
#         starsh reportSignalInformation.tcl design.zdb report.txt
#   @files
#       cust33/reportSignalInformation.tcl
#   @tag
#       zdb batch report rtl
###############################################################################


# =============================================================================
# Start - Report signal information.
# =============================================================================
#
proc ReportSignalInformation:Start {db report} {
    ##
    # Open the report file.
    #
    set out [open $report "w"]

    ##
    # Get the top design.
    #
    set top [$db get_top_design]

    ##
    # Loop over all electrical connections.
    #
    $db flat foreach signal $top signal {
        ##
        # Print the signal.
        #
        puts $out [$db oid print $signal]
    }

    ##
    # Close the report file.
    #
    close $out
}


##
# Check for 2 command line options
#
if {$argc != 2} {
    set    msg "Wrong #of args. Usage:\n"
    append msg "[info nameofexecutable] [info script] <BINFILE> <REPORTFILE>"
    error $msg
}

##
# The design is given as the first argument on the command line.
#
set binfile [lindex $argv 0]

##
# The report file is the second argument on the command line.
#
set report [lindex $argv 1]

##
# Open the binfile.
#
set db [zdb open $binfile]

##
# Create signal report.
#
ReportSignalInformation:Start $db $report

##
# Close the opened database.
#
$db close