tdl-xoa-driver 1.0.0__py3-none-any.whl

xoa_driver/internals/hli_v1/ports/port_l23/bases/port_l23.py

@@ -0,0 +1,527 @@
+import functools
+import typing
+from xoa_driver.internals.commands import (
+    P_CAPABILITIES,
+    P_SPEED,
+    P_SPEEDREDUCTION,
+    P_INTERFRAMEGAP,
+    P_MACADDRESS,
+    P_IPADDRESS,
+    P_ARPREPLY,
+    P_PINGREPLY,
+    P_PAUSE,
+    P_RANDOMSEED,
+    P_LOOPBACK,
+    P_TRAFFIC,
+    # P_CAPTURE,
+    P_XMITONE,
+    P_LATENCYOFFSET,
+    P_LATENCYMODE,
+    P_AUTOTRAIN,
+    P_MIXWEIGHTS,
+    P_TRAFFICERR,
+    P_GAPMONITOR,
+    P_CHECKSUM,
+    P_MIXLENGTH,
+    P_ARPRXTABLE,
+    P_NDPRXTABLE,
+    P_MULTICAST,
+    P_MULTICASTEXT,
+    P_MCSRCLIST,
+    P_MULTICASTHDR,
+    P_TXMODE,
+    P_RATEFRACTION,
+    P_RATEPPS,
+    P_RATEL2BPS,
+    P_PAYLOADMODE,
+    P_TXENABLE,
+    P_MAXHEADERLENGTH,
+    P_TXTIMELIMIT,
+    P_TXTIME,
+    P_XMITONETIME,
+    P_IPV6ADDRESS,
+    P_ARPV6REPLY,
+    P_PINGV6REPLY,
+    P_ERRORS,
+    P_TXPREPARE,
+    P_TXDELAY,
+    P_TPLDMODE,
+    P_TXPACKETLIMIT,
+    P_PFCENABLE,
+    P_TXBURSTPERIOD,
+    P_CAPABILITIES_EXT,
+    P_IGMPV3_GROUP_RECORD_BUNDLE,
+)
+if typing.TYPE_CHECKING:
+    from xoa_driver.internals.core import interfaces as itf
+from xoa_driver.internals.hli_v1.ports import base_port
+from xoa_driver.internals.utils import attributes as utils
+from xoa_driver.internals.utils.indices import index_manager as idx_mgr
+from xoa_driver.internals.state_storage import ports_state
+from xoa_driver.internals.hli_v1.indices.length_term import LengthTermIdx
+from xoa_driver.internals.hli_v1.indices.match_term import MatchTermIdx
+
+from .port_capture import PortCapture
+
+LengthTermIndices = idx_mgr.IndexManager[LengthTermIdx]
+MatchTermIndices = idx_mgr.IndexManager[MatchTermIdx]
+
+
+class TxSinglePacket:
+    """L23 port single-packet transmission"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.send = P_XMITONE(conn, module_id, port_id)
+        """Send one packet from the L23 port without a stream config.
+
+        :type: P_XMITONE
+        """
+
+        self.time = P_XMITONETIME(conn, module_id, port_id)
+        """The time at which the latest packet was transmitted using the P_XMITONE` command.
+
+        :type: P_XMITONETIME
+        """
+
+
+class TxConfiguration:
+    """L23 port TX configuration"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.mode = P_TXMODE(conn, module_id, port_id)
+        """L23 port TX mode.
+
+        :type: P_TXMODE
+        """
+
+        self.enable = P_TXENABLE(conn, module_id, port_id)
+        """Enabling L23 port TX.
+
+        :type: P_TXENABLE
+        """
+
+        self.time_limit = P_TXTIMELIMIT(conn, module_id, port_id)
+        """L23 port TX time limit.
+
+        :type: P_TXTIMELIMIT
+        """
+
+        self.time = P_TXTIME(conn, module_id, port_id)
+        """L23 port TX time.
+
+        :type: P_TXTIME
+        """
+
+        self.prepare = P_TXPREPARE(conn, module_id, port_id)
+        """Prepare L23 port for transmission.
+
+        :type: P_TXPREPARE
+        """
+
+        self.delay = P_TXDELAY(conn, module_id, port_id)
+        """L23 port TX delay.
+
+        :type: P_TXDELAY
+        """
+
+        self.packet_limit = P_TXPACKETLIMIT(conn, module_id, port_id)
+        """L23 port TX packet limit
+
+        :type: P_TXPACKETLIMIT
+        """
+
+        self.burst_period = P_TXBURSTPERIOD(conn, module_id, port_id)
+        """L23 port TX burst period.
+
+        :type: P_TXBURSTPERIOD
+        """
+
+
+class Rate:
+    """L23 port TX rate"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.fraction = P_RATEFRACTION(conn, module_id, port_id)
+        """L23 port rate in ppm.
+
+        :type: P_RATEFRACTION
+        """
+
+        self.pps = P_RATEPPS(conn, module_id, port_id)
+        """L23 port rate in packets per second.
+
+        :type: P_RATEPPS
+        """
+
+        self.l2_bps = P_RATEL2BPS(conn, module_id, port_id)
+        """L23 port rate in L2 bits per second.
+
+        :type: P_RATEL2BPS
+        """
+
+
+class Multicast:
+    """L23 port multicast configuration"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.mode = P_MULTICAST(conn, module_id, port_id)
+        """L23 port multicast mode.
+
+        :type: P_MULTICAST
+        """
+
+        self.mode_extended = P_MULTICASTEXT(conn, module_id, port_id)
+        """L23 port multicast extended mode.
+
+        :type: P_MULTICASTEXT
+        """
+
+        self.source_list = P_MCSRCLIST(conn, module_id, port_id)
+        """L23 port multicast source list.
+
+        :type: P_MCSRCLIST
+        """
+
+        self.header = P_MULTICASTHDR(conn, module_id, port_id)
+        """L23 port multicast IGMP header.
+
+        :type: P_MULTICASTHDR
+        """
+
+        self.igmpv3_group_record_bundle = P_IGMPV3_GROUP_RECORD_BUNDLE(conn, module_id, port_id)
+        """Configure if a single membership report bundles multiple multicast group records to decrease the number of packets sent when using IGMPv3. This command returns <NOTVALID> when the IGMP version is not IGMPv3.
+
+        :type: P_IGMPV3_GROUP_RECORD_BUNDLE
+        """
+
+class IPv4:
+    """L23 port IPv4 configuration"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.address = P_IPADDRESS(conn, module_id, port_id)
+        """L23 port IPv4 address.
+
+        :type: P_IPADDRESS
+        """
+
+        self.arp_reply = P_ARPREPLY(conn, module_id, port_id)
+        """L23 port reply to ARP request.
+
+        :type: P_ARPREPLY
+        """
+
+        self.ping_reply = P_PINGREPLY(conn, module_id, port_id)
+        """L23 port reply to PING request.
+
+        :type: P_PINGREPLY
+        """
+
+
+class IPv6:
+    """L23 port IPv6 configuration"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.address = P_IPV6ADDRESS(conn, module_id, port_id)
+        """L23 port IPv6 address.
+
+        :type: P_IPV6ADDRESS
+        """
+
+        self.arp_reply = P_ARPV6REPLY(conn, module_id, port_id)
+        """L23 port reply to NDP Neighbor Solicitation.
+
+        :type: P_ARPV6REPLY
+        """
+
+        self.ping_reply = P_PINGV6REPLY(conn, module_id, port_id)
+        """L23 port reply to PINGv6 request.
+
+        :type: P_PINGV6REPLY
+        """
+
+
+class NetworkConfiguration:  # will be extended in genuine ports
+    """L23 port networking configuration"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.mac_address = P_MACADDRESS(conn, module_id, port_id)
+        """L23 port MAC address.
+
+        :type: P_MACADDRESS
+        """
+
+        self.ipv4 = IPv4(conn, module_id, port_id)
+        """L23 port IPv4 address configuration.
+        """
+
+        self.ipv6 = IPv6(conn, module_id, port_id)
+        """L23 port IPv6 address configuration.
+        """
+
+
+class LatencyConfiguration:
+    """L23 port latency configuration"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.offset = P_LATENCYOFFSET(conn, module_id, port_id)
+        """L23 port latency offset.
+
+        :type: P_LATENCYOFFSET
+        """
+
+        self.mode = P_LATENCYMODE(conn, module_id, port_id)
+        """L23 port latency measurement mode.
+
+        :type: P_LATENCYMODE
+        """
+
+
+class Mix:
+    """L23 port IMIX configuration"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.weights = P_MIXWEIGHTS(conn, module_id, port_id)
+        """L23 port IMIX weights
+
+        :type: P_MIXWEIGHTS
+        """
+
+        self.lengths = tuple(
+            P_MIXLENGTH(conn, module_id, port_id, idx)
+            for idx in range(16)
+        )  # TODO: need to add manager for handle specific indices only
+        """L23 port IMIX lengths.
+
+        :type: P_MIXLENGTH
+        """
+
+
+class Speed:
+    """L23 port speed configuration"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.current = P_SPEED(conn, module_id, port_id)
+        """L23 port current speed in units of Mbps.
+
+        :type: P_SPEED
+        """
+
+        self.reduction = P_SPEEDREDUCTION(conn, module_id, port_id)
+        """L23 port speed reduction in ppm.
+
+        :type: P_SPEEDREDUCTION
+        """
+
+
+class Traffic:
+    """L23 port traffic generation"""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        self.state = P_TRAFFIC(conn, module_id, port_id)
+        """L23 port traffic status and action.
+
+        :type: P_TRAFFIC
+        """
+
+        self.error = P_TRAFFICERR(conn, module_id, port_id)
+        """L23 port traffic error.
+
+        :type: P_TRAFFICERR
+        """
+
+
+class BasePortL23(base_port.BasePort[ports_state.PortL23LocalState]):
+    """L23 port layout which is relevant to all L23 ports."""
+
+    def __init__(self, conn: "itf.IConnection", module_id: int, port_id: int) -> None:
+        super().__init__(conn, module_id, port_id)
+        self.capabilities = P_CAPABILITIES(conn, module_id, port_id)
+        """L23 port capabilities.
+
+        :type: P_CAPABILITIES
+        """
+
+        self.capabilities_ext = P_CAPABILITIES_EXT(conn, module_id, port_id)
+        """L23 port capabilities ext.
+
+        :type: P_CAPABILITIES_EXT
+        """
+
+        self.pause = P_PAUSE(conn, module_id, port_id)
+        """L23 port response to Ethernet PAUSE frames.
+
+        :type: P_PAUSE
+        """
+
+        self.loop_back = P_LOOPBACK(conn, module_id, port_id)
+        """L23 port loopback mode.
+
+        :type: P_LOOPBACK
+        """
+
+        self.errors_count = P_ERRORS(conn, module_id, port_id)
+        """L23 port errors.
+
+        :type: P_ERRORS
+        """
+
+        self.interframe_gap = P_INTERFRAMEGAP(conn, module_id, port_id)
+        """L23 port interframe gap.
+
+        :type: P_INTERFRAMEGAP
+        """
+
+        self.max_header_length = P_MAXHEADERLENGTH(conn, module_id, port_id)
+        """L23 port maximum header length.
+
+        :type: P_MAXHEADERLENGTH
+        """
+
+        self.tpld_mode = P_TPLDMODE(conn, module_id, port_id)
+        """L23 port test payload mode.
+
+        :type: P_TPLDMODE
+        """
+
+        self.pfc_enable = P_PFCENABLE(conn, module_id, port_id)
+        """L23 port Ethernet Priority Flow Control (PFC).
+
+        :type: P_PFCENABLE
+        """
+
+        self.random_seed = P_RANDOMSEED(conn, module_id, port_id)
+        """L23 port seed value.
+
+        :type: P_RANDOMSEED
+        """
+
+        self.payload_mode = P_PAYLOADMODE(conn, module_id, port_id)
+        """L23 port payload mode.
+
+        :type: P_PAYLOADMODE
+        """
+
+        self.autotrain = P_AUTOTRAIN(conn, module_id, port_id)
+        """L23 port interval between auto training packets.
+
+        :type: P_AUTOTRAIN
+        """
+
+        self.gap_monitor = P_GAPMONITOR(conn, module_id, port_id)
+        """L23 port gap monitor.
+
+        :type: P_GAPMONITOR
+        """
+
+        self.checksum = P_CHECKSUM(conn, module_id, port_id)
+        """L23 port extra payload integrity checksum.
+
+        :type: P_CHECKSUM
+        """
+
+        self.arp_rx_table = P_ARPRXTABLE(conn, module_id, port_id)
+        """L23 port ARP table.
+
+        :type: P_ARPRXTABLE
+        """
+
+        self.ndp_rx_table = P_NDPRXTABLE(conn, module_id, port_id)
+        """L23 port NDP table.
+
+        :type: P_NDPRXTABLE
+        """
+
+        self.capturer = PortCapture(conn, module_id, port_id)
+        """L23 port capturer configuration.
+
+        :type: PortCapture
+        """
+
+        self.speed = Speed(conn, module_id, port_id)
+        """L23 port speed configuration.
+
+        :type: Speed
+        """
+
+        self.traffic = Traffic(conn, module_id, port_id)
+        """L23 port traffic configuration.
+
+        :type: Traffic
+        """
+
+        self.mix = Mix(conn, module_id, port_id)
+        """L23 port IMIX configuration.
+
+        :type: Mix
+        """
+
+        self.latency_config = LatencyConfiguration(conn, module_id, port_id)
+        """L23 port latency configuration.
+
+        self.latency_config = LatencyConfiguration(conn, module_id, port_id)
+        :type:
+        """
+
+        self.rate = Rate(conn, module_id, port_id)
+        """L23 port rate.
+
+        :type: Rate
+        """
+
+        self.tx_config = TxConfiguration(conn, module_id, port_id)
+        """L23 port TX configuration.
+
+        :type: TxConfiguration
+        """
+
+        self.tx_single_pkt = TxSinglePacket(conn, module_id, port_id)
+        """L23 port single-packet TX configuration.
+
+        :type: TxSinglePacket
+        """
+
+        self.multicast = Multicast(conn, module_id, port_id)
+        """L23 port multicast configuration.
+
+        :type: Multicast
+        """
+
+        self.net_config = NetworkConfiguration(conn, module_id, port_id)
+        """L23 port network configuration.
+
+        :type: NetworkConfiguration
+        """
+
+        self.local_states = ports_state.PortL23LocalState()
+        """L23 port local states.
+
+        :type: PortL23LocalState
+        """
+
+        self.length_terms: LengthTermIndices = idx_mgr.IndexManager(
+            conn,
+            LengthTermIdx,
+            module_id,
+            port_id
+        )
+        """L23 port's length term index manager.
+
+        :type: LengthTermIndices
+        """
+
+        self.match_terms: MatchTermIndices = idx_mgr.IndexManager(
+            conn,
+            MatchTermIdx,
+            module_id,
+            port_id
+        )
+        """L23 port's match term index manager.
+
+        :type: MatchTermIndices
+        """
+
+    on_speed_change = functools.partialmethod(utils.on_event, P_SPEED)
+    """Register a callback to the event that the port's speed changes."""
+
+    on_traffic_change = functools.partialmethod(utils.on_event, P_TRAFFIC)
+    """Register a callback to the event that the port's traffic status changes."""