Source code for hwtLib.handshaked.compBase

from typing import Type, Union, Optional, List

from hwt.interfaces.std import Handshaked, HandshakeSync, Signal
from hwt.synthesizer.param import Param
from hwt.synthesizer.unit import Unit
from hwt.synthesizer.interface import Interface


class HandshakedCompBase(Unit):
    """
    Abstract class for components which has Handshaked interface as main
    """

    def __init__(self, hsIntfCls: Type[Union[Handshaked, HandshakeSync]],
                 hdl_name_override:Optional[str]=None):
        """
        :param hsIntfCls: class of interface which should be used
            as interface of this unit
        """
        assert(issubclass(hsIntfCls, (Handshaked, HandshakeSync))), hsIntfCls
        self.intfCls = hsIntfCls
        Unit.__init__(self, hdl_name_override=hdl_name_override)

    def _config(self):
        self.INTF_CLS = Param(self.intfCls)
        self.intfCls._config(self)

    @classmethod
    def get_valid_signal(cls, intf: HandshakeSync) -> Signal:
        return intf.vld

    @classmethod
    def get_ready_signal(cls, intf: HandshakeSync) -> Signal:
        return intf.rd

    def get_data(self, intf: HandshakeSync) -> List[Interface]:
        rd = self.get_ready_signal(intf)
        vld = self.get_valid_signal(intf)
        return [
            x for x in intf._interfaces
            if (x is not rd) and (x is not vld)
        ]