cust22/exportNetlistBatch.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
 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
###############################################################################
# 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.
# =============================================================================
#   @userware
#       Batch Netlist Export
#   @section
#       Miscellaneous Userware Examples
#   @description
#       Read a System Verilog design and export the created netlist as a
#       structural Verilog netlist.
#
#       Usage::
#       ```
#       starsh demo/api/cust22/exportNetlistBatch.tcl    \
#           -rtl                  <READ_RTL_OPTIONS>     \
#           -netlist outputFile.v <NETLIST_EXPORT_OPTIONS>
#       READ_RTL_OPTIONS:
#           All supported options of the zrtl Tcl command.
#       NETLIST_EXPORT_OPTIONS:
#           -namedConnectivity: Create named connectivity.
#           -implementFunction: Add implementations for selected primitives.
#           -gzip:              Write a gzipped output file.
#           -writeSymlib:       Also write a .sym file.
#           -writeLiberty:      Also write a .lib file.
#       ```
#   @files
#       cust22/exportNetlistBatch.tcl
#   @tag
#       rtl netlist
###############################################################################


# =============================================================================
# Start - Process command line options and invoke read RTL and export netlist.
# =============================================================================
#
proc ExportNetlistBatch:Start {args} {
    ##
    # Get the start index of the Spice and Skill options.
    #
    set readRtlOptionsStart       [lsearch -exact $args "-rtl"]
    set netlistExportOptionsStart [lsearch -exact $args "-netlist"]
    if {($readRtlOptionsStart < 0) || ($netlistExportOptionsStart < 0)} {
        error "The options -rtl and -netlist are required."
    }

    ##
    # RTL options need to be before netlist options.
    #
    if {$readRtlOptionsStart > $netlistExportOptionsStart} {
        error "RTL options need to be before netlist options."
    }

    ##
    # Get the read RTL options.
    #
    incr readRtlOptionsStart
    incr netlistExportOptionsStart -1
    set readRtlOptions [lrange $args $readRtlOptionsStart      \
                                     $netlistExportOptionsStart]

    ##
    # Get the netlist export options.
    #
    incr netlistExportOptionsStart 2
    set outputFile [lindex $args $netlistExportOptionsStart]
    incr netlistExportOptionsStart
    set netlistExportOptions [lrange $args $netlistExportOptionsStart end]

    ##
    # Invoke zrtl with the read Spice options.
    #
    set db [zrtl {*}$readRtlOptions]

    ##
    # Invoke ExportNetlist with the Skill export options.
    #
    ExportNetlistBatch:ExportNetlist $db $outputFile {*}$netlistExportOptions
}


# =============================================================================
# ExportNetlist - Export netlist with the given options.
# =============================================================================
#
proc ExportNetlistBatch:ExportNetlist {db outputFile args} {
    puts OUT:===>$outputFile
    puts ARGS:[llength $args]:$args

    if {$db == {}} {
        return
    }

    if {$outputFile eq ""} {
        error "No output filename given."
    }

    set cmd [list $db write verilog -preservenet]
    if {"-namedConnectivity" in $args} {
        lappend cmd -named
    }
    if {"-implementFunction" in $args} {
        lappend cmd -implementFunction
    }
    if {"-gzip" in $args} {
        lappend cmd -gzip
        if {[file extension $outputFile] ne ".gz"} {
            append outputFile ".gz"
        }
    }
    {*}$cmd $outputFile


    if {"-writeSymlib" in $args} {
        set symlibFilename [file rootname $outputFile].sym
        $db symlib add -fromfunc
        $db symlib create $symlibFilename
    }

    if {"-writeLiberty" in $args} {
        set libertyFilename [file rootname $outputFile].lib
        $db write liberty $libertyFilename
    }
}


##
# Start the main procedure.
#
ExportNetlistBatch:Start {*}$argv