Source code for hwtLib.peripheral.i2c.intf

from hwt.hwIOs.hwIOTristate import HwIOTristateClk, HwIOTristateSig
from hwt.simulator.agentBase import AgentWitReset
from hwt.hwIO import HwIO
from ipCorePackager.intfIpMeta import IntfIpMeta
from hwtSimApi.agents.peripheral.i2c import I2cAgent
from hwtSimApi.hdlSimulator import HdlSimulator
from hwt.pyUtils.typingFuture import override




class I2c(HwIO):
    """
    I2C interface also known as IIC, TWI or Two Wire

    If interface is outside of chip it needs pull-up resistors

    .. hwt-autodoc::
    """

    @override
    def hwDeclr(self):
        self.scl = HwIOTristateClk()  # serial clk
        self.sda = HwIOTristateSig()  # serial data



    @override
    def _getIpCoreIntfClass(self):
        return IP_IIC




    @override
    def _initSimAgent(self, sim: HdlSimulator):
        scl = self.scl
        sda = self.sda
        rst = AgentWitReset._discoverReset(self, allowNoReset=True)
        self._ag = I2cAgent(
            sim, (scl, sda), rst)






class IP_IIC(IntfIpMeta):



    def __init__(self):
        super().__init__()
        self.name = "iic"
        self.version = "1.0"
        self.vendor = "xilinx.com"
        self.library = "interface"
        self.map = {"scl": {"t": "SCL_T",
                            "i": "SCL_I",
                            "o": "SCL_O"},
                    "sda": {"t": "SDA_T",
                            "i": "SDA_I",
                            "o": "SDA_O"}
                    }