connectBlocks.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
143
144
145
146
147
148
149
150
151
152
153
154
###############################################################################
# Copyright (c) 2021-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
#       Instantiate two modules with a similar interface into a new toplevel
#       module and connect all pins by their names.
###############################################################################


# =============================================================================
# ConnectBlocks -
# =============================================================================
#
proc ConnectBlocks {blockA blockB intoModule} {
    ##
    # Get the database and return if the database is empty.
    #
    set db [gui database get]
    if {$db == {}} {
        return
    }

    ##
    # Search for the blockA and blockB modules.
    #
    set moduleA [$db search module $blockA]
    if {[$db oid isnull $moduleA]} {
        error "Cannot find module '$blockA' (blockA)."
    }
    set moduleB [$db search module $blockB]
    if {[$db oid isnull $moduleB]} {
        error "Cannot find module '$blockB' (blockB)."
    }

    ##
    # Check if the interfaces of the two selected instances are similar.
    #
    if {![_similarInterface $db $moduleA $moduleB]} {
        if {[_similarInterface $db $moduleB $moduleA]} {
            set tmp     $moduleA
            set moduleA $moduleB
            set moduleB $tmp
        } else {
            error "Interface mismatch."
        }
    }

    ##
    # Check if the into module already exists.
    #
    if {![$db oid isnull [$db search module $intoModule]]} {
        error "The module '$intoModule' already exists' (intoModule)."
    }

    ##
    # Check if either module is a toplevel module.
    #
    if {[$db isTop $moduleA]} {
        $db top unset $moduleA
    }
    if {[$db isTop $moduleB]} {
        $db top unset $moduleB
    }

    ##
    # Load the new 'intoModule' toplevel and instantiate both modules.
    #
    $db load module $intoModule -top
    $db load inst I_[$db oid oname $moduleA] [$db oid oname $moduleA]
    $db load inst I_[$db oid oname $moduleB] [$db oid oname $moduleB]

    ##
    # Connect
    #
    $db foreach port $moduleA portA {
        set portName [$db oid oname $portA]
        set portB    [$db search port $moduleB $portName]

        set mappedName ""
        _findPort $db $moduleB $portA mappedName

        $db load net N_$portName -pin I_[$db oid oname $moduleA] $portName \
                                 -pin I_[$db oid oname $moduleB] $mappedName
    }

    ##
    # Show the results.
    #
    gui database modified
    gui schem setCurrentModule [$db search module $intoModule]
}


# -----------------------------------------------------------------------------
# _findPort -
# -----------------------------------------------------------------------------
#
proc _findPort {db module port mappedNameVar} {
    upvar 1 $mappedNameVar mappedName

    set portName [$db oid oname $port]
    set mappedName $portName

    set match true
    if {[$db oid isnull [$db search port $module $portName]]} {
        set match false
        if {[$db isBusMember $port]} {
            foreach mapping {
                {[ < ] >}
            } {
                set member [string map $mapping $portName]
                if {![$db oid isnull [$db search port $module $member]]} {
                    set match true
                    set mappedName $member
                    break
                }
            }
        }
    }

    return $match
}


# -----------------------------------------------------------------------------
# _similarInterface -
# -----------------------------------------------------------------------------
#
proc _similarInterface {db moduleA moduleB} {
    if {[$db count port $moduleA] != [$db count port $moduleB]} {
        zmessage print WAR "Port count mismatch."
        return false
    }
    $db foreach port $moduleA port {
        set portName [$db oid oname $port]
        set mappedName ""
        if {![_findPort $db $moduleB $port mappedName]} {
            return false
        }
    }
    return true
}