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
###############################################################################
# Copyright (c) 2015-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
#       I/O Port Protection with NMOS and Resistor
#
#       Algorithm
#           1. Identify all inputMOS device gates connected to IO ports.
#           2. Check for ESD resistor between gates and I/O port.
#           3. Check that resistor has a minimum value of 100 Ohm.
#           4. Check for a diode connected NMOS device.
#           5. Add nets with improper ESD protection to the result list.
#
#       Example
#           demo/api/esd/testcase05.sp
###############################################################################


# -----------------------------------------------------------------------------
# countMosPins - count mos gate pins, s/d pin connected with gate to pg
#                (as diode) and for connected resistors return the opposite
#                pin.
# -----------------------------------------------------------------------------
#
proc ESD:countMosPins {db port gatePinsVar diodePinsVar resistorPinsVar \
                       extraPinsVar} {
    upvar 1 $gatePinsVar gatePins
    upvar 1 $diodePinsVar diodePins
    upvar 1 $resistorPinsVar resistorPins
    upvar 1 $extraPinsVar extraPins

    ##
    # Init results
    #
    set gatePins {}
    set diodePins {}
    set resistorPins {}
    set extraPins {}

    ##
    # get connected net
    #
    set net [ESD:connectedNet $db $port]
    if {$net == {}} {
        return
    }

    ##
    # loop over all connected pins
    #
    $db flat foreach pin -addHier $net pin {
        ##
        # Ignore start
        #
        if {[$db oid isequal $pin $port]} {
            continue
        }

        ##
        # store hierPins
        #
        if {[$db oid type $pin] == "port"} {
            lappend extraPins $pin
            continue
        }

        ##
        # Check different function.
        #
        set pinFunc  [ESD:funcName $db $pin]
        if {$pinFunc eq "gate"} {
            lappend gatePins $pin
        } elseif {[ESD:mosDiode $db $pin extraPins]} {
            lappend diodePins $pin
        } else {
            set primFunc [$db primFuncOf $pin]
            if {$primFunc eq "RES"} {
                ##
                # Get opposite resistor pin
                #
                set resistorPin [ESD:oppositePin $db $pin]
                if {$resistorPin != {}} {
                    lappend resistorPins $resistorPin
                    lappend extraPins $pin
                }
            } else {
                lappend extraPins $pin
            }
        }
    }
}


# -----------------------------------------------------------------------------
# check05Port - Check whether port is connected to minimum 200 ohm resistor.
# -----------------------------------------------------------------------------
#
proc ESD:check05Port {db port resultListVar} {
    upvar 1 $resultListVar resultList

    ##
    # Get connected gate pins
    #
    set gatePins {}
    set diodePins {}
    set resistorPins {}
    set extraPins {}
    ESD:countMosPins $db $port gatePins diodePins resistorPins extraPins

    ##
    # Gate pins direct connected to port are invalid
    #
    if {[llength $gatePins] > 0} {
        foreach gatePin $gatePins {
            set msg "direct gate '[$db oid print $gatePin]' connection"
            set oids [ESD:filterOids $db $gatePin $port $extraPins]
            ESD:appendResult resultList $port $oids $msg
        }
        return
    }

    ##
    #
    # Check for invalid gates connected via resistor
    #
    foreach resistorPin $resistorPins {
        ##
        # Look for gates, diodes
        #
        set gatePins {}
        set morePins {}
        ESD:countMosPins $db $resistorPin gatePins diodePins notNeeded morePins

        ##
        # Check resistor value for gate pins connected via resistor.
        #
        if {[llength $gatePins] > 0} {
            ##
            # Get instance of pin
            #
            set inst [$db oid convertTo inst $resistorPin]

            ##
            # set oid list
            #
            set     oids [concat $gatePins $diodePins $morePins $extraPins]
            lappend oids $resistorPin

            ##
            # Get resistor value
            #
            set resValue [$db attr $inst getValue "R"]

            ##
            # Gate pins connected via too small resistor is invalid
            #
            if {$resValue < 100} {
                set    msg "resistor '[$db oid print $inst]' value $resValue"
                append msg " too small"
                ESD:appendResult resultList $port $oids $msg
                return
            }

            ##
            # Check for missing diode MOS device
            #
            if {[llength $diodePins] == 0} {
                ESD:appendResult resultList $port $oids "no mos diode"
                return
            }

            ##
            # gate ok
            #
            ESD:appendResult resultList $port $oids ""
        }
    }
}


# =============================================================================
# Check05 - I/O Port Protection with NMOS and Resistor
# =============================================================================
#
proc ESD:Check05 {db} {
    ##
    # Initialize the result list.
    #
    set resultList {}

    ##
    # Get top module.
    #
    set top [$db get_top_design]

    ##
    # Count top level ports
    #
    set count 0
    $db foreach port $top port {
        incr count
    }

    ##
    # Loop over all top level ports
    #
    set i 0
    $db foreach port $top port {
        zprogress push "" [expr {double([incr i]) / $count}]

        ESD:check05Port $db $port resultList
        if {[zprogress pop]} {
            break
        }
    }

    ##
    # Return the calculated result.
    #
    return $resultList
}