Source code for xbase.layout.enum

# SPDX-License-Identifier: Apache-2.0
# Copyright 2019 Blue Cheetah Analog Design Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from __future__ import annotations

from typing import Union

from enum import Enum, Flag, auto, IntEnum


[docs]class MOSType(Enum):
[docs]    nch = 0
[docs]    ptap = 1
[docs]    pch = 2
[docs]    ntap = 3

    @property
[docs]    def is_substrate(self) -> bool:
        return self is MOSType.ptap or self is MOSType.ntap

    @property
[docs]    def is_pwell(self) -> bool:
        return self is MOSType.nch or self is MOSType.ptap

    @property
[docs]    def sub_type(self) -> MOSType:
        return MOSType.ptap if self is MOSType.nch or self is MOSType.ptap else MOSType.ntap

    @property
[docs]    def is_n_plus(self) -> bool:
        return self is MOSType.ntap or self is MOSType.nch

[docs]    def is_same_implant(self, other: MOSType) -> bool:
        return self.is_n_plus == other.is_n_plus


[docs]class SubPortMode(Enum):
[docs]    EVEN = 0
[docs]    ODD = 1
[docs]    BOTH = 2


[docs]class MOSCutMode(Flag):
[docs]    BOT = auto()
[docs]    TOP = auto()
[docs]    MID = auto()
[docs]    BOTH = BOT | TOP

    @property
[docs]    def num_cut(self) -> int:
        if not self:
            return 0
        if self is MOSCutMode.BOTH:
            return 2
        return 1


# Note: make this IntEnum so it is sortable by ImmutableSortedDict.
[docs]class MOSWireType(IntEnum):
    """
    These describe the placements of tracks above the conn_layer, relative to 
    the conn_layer ports.

    G: tracks directly over gate connection
    G_MATCH: tracks south of gate connection to match / reduce gate parasitics
    DS: tracks directly over drain / source connection
    DS_GATE: track over drain/source, overlapping with gate if possible
    DS_MATCH: tracks north of drain/source conn to match / reduce parasitics
    G2: for double gate transistors, tracks directly over the 2nd gate
    G2_MATCH: similar to G_MATCH for double gate transistors

    For flipped transistors, G will be at the top, DS / G2 will be at the bottom.
    For not flipped transistors, G will be at the bottom, DS / G2 will be at the top.

    """
[docs]    G = 0
[docs]    G_MATCH = 1
[docs]    DS = 2
[docs]    DS_GATE = 3
[docs]    DS_MATCH = 4
[docs]    G2 = 5
[docs]    G2_MATCH = 6

    @property
[docs]    def is_gate(self) -> bool:
        return self is MOSWireType.G or self is MOSWireType.G_MATCH

    @property
[docs]    def is_gate2(self) -> bool:
        return self is MOSWireType.G2 or self is MOSWireType.G2_MATCH

    @property
[docs]    def is_physical(self) -> bool:
        return not (self is MOSWireType.G_MATCH or self is MOSWireType.DS_MATCH
                    or self is MOSWireType.G2_MATCH)


[docs]class MOSPortType(Enum):
[docs]    G = 0
[docs]    D = 1
[docs]    S = 2


[docs]class MOSAbutMode(Enum):
[docs]    NONE = 0
[docs]    OVERLAY = 1
[docs]    UPDATE = 2


[docs]class Alignment(Enum):
[docs]    LOWER_COMPACT = 0
[docs]    CENTER_COMPACT = 1
[docs]    UPPER_COMPACT = 2

    @property
[docs]    def is_center(self) -> bool:
        return self is Alignment.CENTER_COMPACT


[docs]class ExtendMode(Enum):
[docs]    X = 0
[docs]    Y = 1
[docs]    AREA = 2


[docs]class DeviceType(Enum):
[docs]    MOS = 0
[docs]    RES = 1
[docs]    DIODE = 2


[docs]class CornerType(Enum):
[docs]    BOTTOM_LEFT = 0
[docs]    BOTTOM_RIGHT = 1
[docs]    TOP_LEFT = 2
[docs]    TOP_RIGHT = 3
[docs]    BL = 0
[docs]    BR = 1
[docs]    TL = 2
[docs]    TR = 3

    @property
[docs]    def is_bottom(self) -> bool:
        return self.value & 2 == 0

    @property
[docs]    def is_left(self) -> bool:
        return self.value & 1 == 0

    @classmethod
[docs]    def convert(cls, val: Union[int, str]) -> CornerType:
        if isinstance(val, str):
            return CornerType[val]
        else:
            return CornerType(val)