tdl-xoa-driver 1.5.0b2__py3-none-any.whl → 1.6.0__py3-none-any.whl

xoa_driver/internals/commands/pl_commands.py

@@ -1,3 +1,4 @@
+"""Port Length Term Commands"""
 from __future__ import annotations
 from dataclasses import dataclass
 import typing
@@ -176,3 +177,10 @@ class PL_LENGTH:
     set_at_least = functools.partialmethod(set, LengthCheckType.AT_LEAST)
     """Set the length check to be longer than or equal to the given length (at least).
     """
+
+__all__ = [
+    "PL_CREATE",
+    "PL_DELETE",
+    "PL_INDICES",
+    "PL_LENGTH",
+]

xoa_driver/internals/commands/pm_commands.py

@@ -1,3 +1,4 @@
+"""Port Match Term Commands"""
 from __future__ import annotations
 from dataclasses import dataclass
 import typing
@@ -254,3 +255,13 @@ class PM_MATCH:
         """
 
         return Token(self._connection, build_set_request(self, module=self._module, port=self._port, indices=[self._match_term_xindex], mask=mask, value=value))
+
+
+__all__ = [
+    "PM_CREATE",
+    "PM_DELETE",
+    "PM_INDICES",
+    "PM_MATCH",
+    "PM_POSITION",
+    "PM_PROTOCOL",
+]

xoa_driver/internals/commands/pp_commands.py

@@ -1,3 +1,4 @@
+"""Port Basic Layer 1 Commands"""
 from __future__ import annotations
 from dataclasses import dataclass
 import typing
@@ -263,6 +264,14 @@ class PP_TXPRBSCONFIG:
                 error_on_off=error_on_off
             )
         )
+    
+    set_on = functools.partialmethod(set, 17, PRBSOnOff.PRBSON, ErrorOnOff.ERRORSOFF)
+    """Enable PRBS transmission on this SerDes without error injection.
+    """
+
+    set_off = functools.partialmethod(set, 17, PRBSOnOff.PRBSOFF, ErrorOnOff.ERRORSOFF)
+    """Disable PRBS transmission on this SerDes without error injection.
+    """
 
 
 @register_command
@@ -595,7 +604,7 @@ class PP_PMAERRPUL_PARAMS:
     def set(self, duration: int, period: int, repetition: int, coeff: int, exp: int) -> Token[None]:
         """Set PMA pulse error injection settings.
 
-        :param duration: 0 ms - 5000m s; increments of 1 ms; 0 = constant BER
+        :param duration: 0 ms - 5000 ms; increments of 1 ms; 0 = constant BER
         :type duration: int
         :param period: 10 ms - 50000 ms; number of ms - must be multiple of 10 ms
         :type period: int
@@ -840,7 +849,7 @@ class PP_TXLASERPOWER:
 @dataclass
 class PP_PMAERRPUL_ENABLE:
     """
-    Enable / disable 'PMA pulse error inject'.
+    Enable / disable PMA pulse error inject.
     """
 
     code: typing.ClassVar[int] = 300
@@ -868,8 +877,8 @@ class PP_PMAERRPUL_ENABLE:
         return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
 
     def set(self, on_off: OnOff) -> Token[None]:
-        """Set the status of 'PMA pulse error inject'.
-
+        """Set the status of PMA pulse error inject.
+        
         :param on_off: whether PMA pulse error inject is enabled
         :type on_off: OnOff
         """
@@ -1117,7 +1126,19 @@ class PP_EYEINFO:
 class PP_PHYTXEQ:
     """
     Control and monitor the equalizer settings of the on-board PHY in the
-    transmission direction (towards the transceiver cage) on Thor and Loki modules.
+    transmission direction (towards the transceiver cage).
+
+    This command returns a variable number of tap values with module-dependent ordering:
+
+    - **Legacy Loki-2P/Thor**: Original fixed format [pre, main, post, pre2, pre3, mode]
+    - **Regular Freya**: Original fixed format [pre, main, post, pre2, pre3, mode]
+    - **Loki-4P and H-Freya/Edun**: Variable number in N*pre, main, M*post layout
+      [pre_n, pre_n-1, ..., pre_1, main, post_1, post_2, ..., post_m]
+
+    Use P_CAPABILITIES to query ``numtxeqtaps`` and ``numtxeqpretaps`` to determine
+    the number of taps and layout:
+    - ``numtxeqpretaps``: Number of precursor taps (N)
+    - ``numtxeqtaps - numtxeqpretaps - 1``: Number of postcursor taps (M)
 
     .. versionchanged:: 1.1
 
@@ -1132,63 +1153,46 @@ class PP_PHYTXEQ:
     _serdes_xindex: int
 
     class GetDataAttr(ResponseBodyStruct):
-        pre: int = field(XmpInt())
-        """integer, preemphasis, (range: Module dependent), default = 0 (neutral)."""
-        main: int = field(XmpInt())
-        """integer, amplification, (range: Module dependent), default = 0 (neutral)."""
-        post: int = field(XmpInt())
-        """integer, postemphasis, (range: Module dependent), default = 0 (neutral)."""
-        pre2: int = field(XmpInt())
-        """integer, preemphasis, (range: Module dependent), default = 0 (neutral)."""
-        pre3_post2: int = field(XmpInt())
-        """integer, postemphasis, (range: Module dependent), default = 0 (neutral)."""
-        post3: int = field(XmpInt())
-        """integer, postemphasis, (range: Module dependent), default = 0 (neutral)."""
-        mode: int = field(XmpInt())
-        """integer, value must be 4"""
+        tap_values: typing.List[int] = field(XmpSequence(types_chunk=[XmpInt()]))
+        """list of integers, TX EQ tap values. The number and layout depend on the platform:
+
+        - Legacy Loki-2P/Thor and Regular Freya: [pre, main, post, pre2, pre3, mode]
+        - Loki-4P and H-Freya/Edun: [pre_n, ..., pre_1, main, post_1, ..., post_m]
+          where N = numtxeqpretaps and M = numtxeqtaps - numtxeqpretaps - 1
+        """
 
     class SetDataAttr(RequestBodyStruct):
-        pre: int = field(XmpInt())
-        """integer, preemphasis, (range: Module dependent), default = 0 (neutral)."""
-        main: int = field(XmpInt())
-        """integer, amplification, (range: Module dependent), default = 0 (neutral)."""
-        post: int = field(XmpInt())
-        """integer, postemphasis, (range: Module dependent), default = 0 (neutral)."""
-        pre2: int = field(XmpInt())
-        """integer, preemphasis, (range: Module dependent), default = 0 (neutral)."""
-        pre3_post2: int = field(XmpInt())
-        """integer, postemphasis, (range: Module dependent), default = 0 (neutral)."""
-        post3: int = field(XmpInt())
-        """integer, postemphasis, (range: Module dependent), default = 0 (neutral)."""
-        mode: int = field(XmpInt())
-        """integer, value must be 4"""
+        tap_values: typing.List[int] = field(XmpSequence(types_chunk=[XmpInt()]))
+        """list of integers, TX EQ tap values. The number and layout depend on the platform:
+
+        - Legacy Loki-2P/Thor and Regular Freya: [pre, main, post, pre2, pre3, mode]
+        - Loki-4P and H-Freya/Edun: [pre_n, ..., pre_1, main, post_1, ..., post_m]
+          where N = numtxeqpretaps and M = numtxeqtaps - numtxeqpretaps - 1
+        """
 
     def get(self) -> Token[GetDataAttr]:
-        """Get the equalizer settings of the on-board PHY in the
-        transmission direction (towards the transceiver cage) on Thor and Loki modules.
+        """Get the TX equalizer settings of the on-board PHY.
+
+        The returned tap values layout depends on the platform. Query P_CAPABILITIES
+        for ``numtxeqtaps`` and ``numtxeqpretaps`` to determine the format.
 
-        :return: preemphasis, (range: Module dependent), default = 0 (neutral).
+        :return: list of TX EQ tap values
         :rtype: PP_PHYTXEQ.GetDataAttr
         """
 
         return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._serdes_xindex]))
 
-    def set(self, pre2: int, pre: int, main: int, post: int, pre3_post2: int, post3: int) -> Token[None]:
-        """Set the equalizer settings of the on-board PHY in the
-        transmission direction (towards the transceiver cage) on Thor and Loki modules.
+    def set(self, tap_values: typing.List[int]) -> Token[None]:
+        """Set the TX equalizer settings of the on-board PHY.
+
+        The tap values layout depends on the platform. Query P_CAPABILITIES
+        for ``numtxeqtaps`` and ``numtxeqpretaps`` to determine the required format:
+
+        - Legacy Loki-2P/Thor and Regular Freya: [pre, main, post, pre2, pre3, mode]
+        - Loki-4P and H-Freya/Edun: [pre_n, ..., pre_1, main, post_1, ..., post_m]
 
-        :param pre2: pre2 emphasis
-        :type pre2: int
-        :param pre: pre emphasis
-        :type pre: int
-        :param main: main emphasis
-        :type main: int
-        :param post: post emphasis
-        :type post: int
-        :param pre3_post2: post2 or pre3 emphasis
-        :type pre3_post2: int
-        :param post3: post3 emphasis
-        :type post3: int
+        :param tap_values: list of TX EQ tap values in platform-specific order
+        :type tap_values: typing.List[int]
         """
 
         return Token(
@@ -1198,13 +1202,7 @@ class PP_PHYTXEQ:
                 module=self._module,
                 port=self._port,
                 indices=[self._serdes_xindex],
-                pre2=pre2,
-                pre=pre,
-                main=main,
-                post=post,
-                pre3_post2=pre3_post2,
-                post3=post3,
-                mode=4))
+                tap_values=tap_values))
 
 
 @register_command
@@ -1957,8 +1955,7 @@ class PP_PHYRXEQSTATUS_EXT:
 @dataclass
 class PP_AUTONEG:
     """
-    Auto-negotiation settings of the PHY - for Thor-400G-7S-1P Thor-400G-7S-1P[b]
-    and [c]
+    Basic Auto-negotiation configuration and control
     """
 
     code: typing.ClassVar[int] = 381
@@ -1971,25 +1968,25 @@ class PP_AUTONEG:
     class GetDataAttr(ResponseBodyStruct):
         mode: AutoNegMode = field(XmpInt())
         """coded integer, mode"""
-        tec_ability: AutoNegTecAbility = field(XmpInt())
-        """coded integer, technical ability."""
-        fec_capable: int = field(XmpInt())
+        tec_ability: Hex = field(XmpHex(size=8))
+        """hex string, technical ability."""
+        fec_capable: Hex = field(XmpHex(size=1))
         """coded integer, FEC capable."""
-        fec_requested: int = field(XmpInt())
+        fec_requested: Hex = field(XmpHex(size=1))
         """coded integer, FEC requested."""
-        pause_mode: PauseMode = field(XmpInt())
+        pause_mode: Hex = field(XmpHex(size=1))
         """coded integer, pause mode."""
 
     class SetDataAttr(RequestBodyStruct):
         mode: AutoNegMode = field(XmpInt())
         """coded integer, mode"""
-        tec_ability: AutoNegTecAbility = field(XmpInt())
-        """coded integer, technical ability."""
-        fec_capable: int = field(XmpInt())
+        tec_ability: Hex = field(XmpHex(size=8))
+        """hex string, technical ability."""
+        fec_capable: Hex = field(XmpHex(size=1))
         """coded integer, FEC capable."""
-        fec_requested: int = field(XmpInt())
+        fec_requested: Hex = field(XmpHex(size=1))
         """coded integer, FEC requested."""
-        pause_mode: PauseMode = field(XmpInt())
+        pause_mode: Hex = field(XmpHex(size=1))
         """coded integer, pause mode."""
 
     def get(self) -> Token[GetDataAttr]:
@@ -2001,19 +1998,19 @@ class PP_AUTONEG:
 
         return Token(self._connection, build_get_request(self, module=self._module, port=self._port))
 
-    def set(self, mode: AutoNegMode, tec_ability: AutoNegTecAbility, fec_capable: AutoNegFECOption, fec_requested: AutoNegFECOption, pause_mode: PauseMode) -> Token[None]:
+    def set(self, mode: AutoNegMode, tec_ability: Hex, fec_capable: Hex, fec_requested: Hex, pause_mode: Hex) -> Token[None]:
         """Set the auto-negotiation settings of the PHY.
 
         :param mode: auto neg mode
         :type mode: AutoNegMode
-        :param tec_ability: technical ability
-        :type tec_ability: AutoNegTecAbility
+        :param tec_ability: technical ability (hex string with 0x prefix or AutoNegTecAbility enum)
+        :type tec_ability: Hex
         :param fec_capable: FEC capable
-        :type fec_capable: AutoNegFECOption
+        :type fec_capable: Hex
         :param fec_requested: FEC requested
-        :type fec_requested: AutoNegFECOption
-        :param pause_mode: pause mode
-        :type pause_mode: PauseMode
+        :type fec_requested: Hex
+        :param pause_mode: pause mode (hex string with 0x prefix or PauseMode enum)
+        :type pause_mode: Hex
         """
 
         return Token(
@@ -2035,7 +2032,7 @@ class PP_AUTONEG:
 @dataclass
 class PP_AUTONEGSTATUS:
     """
-    Status of auto-negotiation settings of the PHY - for Thor-400G-7S-1P[b] and [c]
+    Basic Auto-negotiation status
     """
 
     code: typing.ClassVar[int] = 382
@@ -2052,13 +2049,13 @@ class PP_AUTONEGSTATUS:
         """codec integer, FEC."""
         auto_state: AutoNegStatus = field(XmpInt())
         """coded integer, auto-negotiation state."""
-        tec_ability: AutoNegTecAbility = field(XmpInt())
+        tec_ability: Hex = field(XmpHex(size=8))
         """coded integer, technical ability."""
-        fec_capable: int = field(XmpInt())
+        fec_capable: Hex = field(XmpHex(size=1))
         """coded integer, FEC capable partner."""
-        fec_requested: int = field(XmpInt())
+        fec_requested: Hex = field(XmpHex(size=1))
         """coded integer, FEC requested partner."""
-        pause_mode: PauseMode = field(XmpInt())
+        pause_mode: Hex = field(XmpHex(size=1))
         """coded integer, pause mode."""
 
     def get(self) -> Token[GetDataAttr]:
@@ -2339,3 +2336,52 @@ class PP_PRECODINGSTATUS:
         """
 
         return Token(self._connection, build_get_request(self, module=self._module, port=self._port, indices=[self._serdes_xindex]))
+
+
+__all__ = [
+    "PP_ALARMS_ERRORS",
+    "PP_AUTONEG",
+    "PP_AUTONEGSTATUS",
+    "PP_EYEBER",
+    "PP_EYEDWELLBITS",
+    "PP_EYEINFO",
+    "PP_EYEMEASURE",
+    "PP_EYEREAD",
+    "PP_EYERESOLUTION",
+    "PP_FECMODE",
+    "PP_GRAYCODING",
+    "PP_LINKFLAP_ENABLE",
+    "PP_LINKFLAP_PARAMS",
+    "PP_LINKTRAIN",
+    "PP_LINKTRAINSTATUS",
+    "PP_PHYAUTONEG",
+    "PP_PHYAUTOTUNE",
+    "PP_PHYRETUNE",
+    "PP_PHYRXEQ",
+    "PP_PHYRXEQSTATUS_EXT",
+    "PP_PHYRXEQ_EXT",
+    "PP_PHYSETTINGS",
+    "PP_PHYSIGNALSTATUS",
+    "PP_PHYTXEQ",
+    "PP_PMAERRPUL_ENABLE",
+    "PP_PMAERRPUL_PARAMS",
+    "PP_PRBSTYPE",
+    "PP_PRECODING",
+    "PP_PRECODINGSTATUS",
+    "PP_RXCLEAR",
+    "PP_RXFECSTATS",
+    "PP_RXLANEERRORS",
+    "PP_RXLANELOCK",
+    "PP_RXLANESTATUS",
+    "PP_RXLASERPOWER",
+    "PP_RXPRBSSTATUS",
+    "PP_RXPRBSTYPE",
+    "PP_RXTOTALSTATS",
+    "PP_TXERRORRATE",
+    "PP_TXINJECTONE",
+    "PP_TXLANECONFIG",
+    "PP_TXLANEINJECT",
+    "PP_TXLASERPOWER",
+    "PP_TXPRBSCONFIG",
+    "PP_TXPRBSTYPE",
+]

xoa_driver/internals/commands/pr_commands.py

@@ -1,3 +1,4 @@
+"""Port Rx Statistics Commands"""
 from __future__ import annotations
 from dataclasses import dataclass
 import typing
@@ -803,3 +804,27 @@ class PR_FLOWCLEAR:
         """
 
         return Token(self._connection, build_set_request(self, module=self._module, port=self._port, indices=[self._flow_xindex]))
+
+
+__all__ = [
+    "PR_CALIBRATE",
+    "PR_CLEAR",
+    "PR_EXTRA",
+    "PR_FILTER",
+    "PR_FILTEREXT",
+    "PR_FLOWCLEAR",
+    "PR_FLOWTOTAL",
+    "PR_NOTPLD",
+    "PR_NOTPLDEXT",
+    "PR_PFCSTATS",
+    "PR_TOTAL",
+    "PR_TOTALEXT",
+    "PR_TPLDERRORS",
+    "PR_TPLDJITTER",
+    "PR_TPLDLATENCY",
+    "PR_TPLDS",
+    "PR_TPLDTRAFFIC",
+    "PR_TPLDTRAFFICEXT",
+    "PR_UAT_STATUS",
+    "PR_UAT_TIME",
+]

xoa_driver/internals/commands/ps_commands.py

@@ -1,3 +1,4 @@
+"""Port Stream Commands"""
 from __future__ import annotations
 from dataclasses import dataclass
 import ipaddress
@@ -2306,4 +2307,49 @@ class PS_MODIFIER_ENDIAN:
 
     set_little_endia = functools.partialmethod(set, mode=ModifierEndianness.LITTLE)
     """Set a stream modifier endianness to Little Endian.
-    """
+    """
+
+__all__ = [
+    "PS_ARPREQUEST",
+    "PS_AUTOADJUST",
+    "PS_BURST",
+    "PS_BURSTGAP",
+    "PS_CDFCOUNT",
+    "PS_CDFDATA",
+    "PS_CDFOFFSET",
+    "PS_COMMENT",
+    "PS_CREATE",
+    "PS_DELETE",
+    "PS_ENABLE",
+    "PS_EXTPAYLOAD",
+    "PS_HEADERPROTOCOL",
+    "PS_INDICES",
+    "PS_INJECTFCSERR",
+    "PS_INJECTMISERR",
+    "PS_INJECTPLDERR",
+    "PS_INJECTSEQERR",
+    "PS_INJECTTPLDERR",
+    "PS_INSERTFCS",
+    "PS_IPV4GATEWAY",
+    "PS_IPV6GATEWAY",
+    "PS_MACSEC_ASSIGN",
+    "PS_MACSEC_ENABLE",
+    "PS_MODIFIER",
+    "PS_MODIFIERCOUNT",
+    "PS_MODIFIEREXT",
+    "PS_MODIFIEREXTCOUNT",
+    "PS_MODIFIEREXTRANGE",
+    "PS_MODIFIERRANGE",
+    "PS_MODIFIER_ENDIAN",
+    "PS_OPTIONS",
+    "PS_PACKETHEADER",
+    "PS_PACKETLENGTH",
+    "PS_PACKETLIMIT",
+    "PS_PAYLOAD",
+    "PS_PFCPRIORITY",
+    "PS_PINGREQUEST",
+    "PS_RATEFRACTION",
+    "PS_RATEL2BPS",
+    "PS_RATEPPS",
+    "PS_TPLDID",
+]

xoa_driver/internals/commands/pt_commands.py

@@ -1,3 +1,4 @@
+"""Port Tx Statistics Commands"""
 from __future__ import annotations
 from dataclasses import dataclass
 import typing
@@ -382,3 +383,17 @@ class PT_FLOWCLEAR:
         """
 
         return Token(self._connection, build_set_request(self, module=self._module, port=self._port, indices=[self._flow_xindex]))
+
+
+__all__ = [
+    "PT_CLEAR",
+    "PT_EXTRA",
+    "PT_FLOWCLEAR",
+    "PT_FLOWTOTAL",
+    "PT_NOTPLD",
+    "PT_NOTPLDEXT",
+    "PT_STREAM",
+    "PT_STREAMEXT",
+    "PT_TOTAL",
+    "PT_TOTALEXT",
+]