tdl-xoa-driver 1.1.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

xoa_driver/functions/mgmt.py

@@ -11,6 +11,7 @@ from xoa_driver.testers import GenericAnyTester, L23Tester
 from .exceptions import (
     NotSupportMedia,
     NotSupportPortSpeed,
+    NotSupportMediaPortSpeed,
 )
 from .tools import MODULE_EOL_INFO
 from itertools import chain  # type: ignore[Pylance false warning]
@@ -25,8 +26,6 @@ LinkTrainingSupported = FamilyL
 # region Testers
 async def reserve_tester(tester: GenericAnyTester, force: bool = True) -> None:
     """
-    .. versionadded:: 1.1
-
     Reserve a tester regardless whether it is owned by others or not.
 
     :param tester: The tester to reserve
@@ -39,25 +38,23 @@ async def reserve_tester(tester: GenericAnyTester, force: bool = True) -> None:
     r = await tester.reservation.get()
     if force and r.operation == enums.ReservedStatus.RESERVED_BY_OTHER:
         await tester.reservation.set_relinquish()
-        await asyncio.gather(*(free_module(m, True) for m in tester.modules))
+        await asyncio.gather(*(release_module(m, True) for m in tester.modules))
         await tester.reservation.set_reserve()
     elif r.operation == enums.ReservedStatus.RELEASED:
         await tester.reservation.set_reserve()
 
 
-async def free_tester(
+async def release_tester(
         tester: GenericAnyTester, 
-        should_free_modules_ports: bool = False,
+        should_release_modules_ports: bool = False,
         ) -> None:
     """
-    .. versionadded:: 1.1
-
     Free a tester. If the tester is reserved by you, release the tester. If the tester is reserved by others, relinquish the tester. The tester should have no owner afterwards.
 
     :param tester: The tester to free
     :type tester: :class:`~xoa_driver.testers.GenericAnyTester`
-    :param should_free_modules_ports: should modules and ports also be freed, defaults to False
-    :type should_free_modules_ports: bool, optional
+    :param should_release_modules_ports: should modules and ports also be freed, defaults to False
+    :type should_release_modules_ports: bool, optional
     :return:
     :rtype: None
     """
@@ -66,14 +63,12 @@ async def free_tester(
         await tester.reservation.set_relinquish()
     elif r.operation == enums.ReservedStatus.RESERVED_BY_YOU:
         await tester.reservation.set_release()
-    if should_free_modules_ports:
-        await asyncio.gather(*(free_module(m, True) for m in tester.modules))
+    if should_release_modules_ports:
+        await asyncio.gather(*(release_module(m, True) for m in tester.modules))
 
 
 async def get_chassis_sys_uptime_sec(tester: L23Tester) -> int:
     """
-    .. versionadded:: 2.7.2
-
     Get chassis system uptime in seconds
 
     :param tester: The tester to free
@@ -96,8 +91,6 @@ async def get_chassis_sys_uptime_sec(tester: L23Tester) -> int:
 
 def get_module(tester: GenericAnyTester, module_id: int) -> GenericAnyModule:
     """
-    .. versionadded:: 1.1
-
     Get a module object of the tester.
 
     :param tester: The tester object
@@ -113,8 +106,6 @@ def get_module(tester: GenericAnyTester, module_id: int) -> GenericAnyModule:
 
 def get_modules(tester: GenericAnyTester) -> tuple[GenericAnyModule, ...]:
     """
-    .. versionadded:: 1.1
-
     Get all modules of the tester
 
     :param tester: The tester object
@@ -127,8 +118,6 @@ def get_modules(tester: GenericAnyTester) -> tuple[GenericAnyModule, ...]:
 
 async def reserve_module(module: GenericAnyModule, force: bool = True) -> None:
     """
-    .. versionadded:: 1.1
-
     Reserve a module regardless whether it is owned by others or not.
 
     :param module: The module to reserve
@@ -140,24 +129,22 @@ async def reserve_module(module: GenericAnyModule, force: bool = True) -> None:
     """
     r = await module.reservation.get()
     if force and r.operation == enums.ReservedStatus.RESERVED_BY_OTHER:
-        await free_module(module, True)
+        await release_module(module, True)
         await module.reservation.set_reserve()
     elif r.operation == enums.ReservedStatus.RELEASED:
         await module.reservation.set_reserve()
 
 
-async def free_module(
-    module: GenericAnyModule, should_free_ports: bool = False
+async def release_module(
+    module: GenericAnyModule, should_release_ports: bool = False
 ) -> None:
     """
-    .. versionadded:: 1.2
-
     Free a module. If the module is reserved by you, release the module. If the module is reserved by others, relinquish the module. The module should have no owner afterwards.
 
     :param module: The module to free
     :type module: :class:`~xoa_driver.modules.GenericAnyModule`
-    :param should_free_ports: should ports also be freed, defaults to False
-    :type should_free_ports: bool, optional
+    :param should_release_ports: should ports also be freed, defaults to False
+    :type should_release_ports: bool, optional
     :return:
     :rtype: None
     """
@@ -166,16 +153,14 @@ async def free_module(
         await module.reservation.set_relinquish()
     elif r.operation == enums.ReservedStatus.RESERVED_BY_YOU:
         await module.reservation.set_release()
-    if should_free_ports:
-        await free_ports(*module.ports)
+    if should_release_ports:
+        await release_ports(*module.ports)
 
 
 def get_module_supported_media(
     module: GenericL23Module | ModuleChimera,
 ) -> list[dict[str, t.Any]]:
     """
-    .. versionadded:: 1.3
-
     Get a list of supported media, port speed and count of the module.
 
     :param module: The module object
@@ -187,7 +172,7 @@ def get_module_supported_media(
     item = {}
 
     for media_item in module.info.media_info_list:  # type: ignore
-        for sub_item in media_item.available_speeds:
+        for sub_item in media_item.supported_configs:
             item = dict()
             item["media"] = media_item.cage_type
             item["port_count"] = sub_item.port_count
@@ -203,8 +188,6 @@ async def set_module_media_config(
     force: bool = True,
 ) -> None:
     """
-    .. versionadded:: 1.3
-
     Set module's media configuration.
 
     :param module: The module object
@@ -227,7 +210,8 @@ async def set_module_media_config(
     # set the module media if the target media is found in supported media
     for item in supported_media_list:
         if item["media"] == media:
-            await module.media.set(media_config=media)
+            await module.config.media.set(media_config=media)
+            await release_module(module, False)
             return None
 
     # raise exception is the target media is not found in the supported media
@@ -241,8 +225,6 @@ async def set_module_port_config(
     force: bool = True,
 ) -> None:
     """
-    .. versionadded:: 1.3
-
     Set module's port-speed configuration
 
     :param module: The module object
@@ -259,14 +241,13 @@ async def set_module_port_config(
     """
 
     # reserve the module first
-    await free_module(module, True)
     await reserve_module(module, force)
 
     # get the supported media by the module
     supported_media_list = get_module_supported_media(module)
 
     # get the current media of the module
-    reply = await module.media.get()
+    reply = await module.config.media.get()
     current_media = reply.media_config
 
     # set the module port speed if we can find the port-speed in the corresponding media
@@ -279,16 +260,59 @@ async def set_module_port_config(
             )
         ):
             portspeed_list = [port_count] + port_count * [port_speed]
-            await module.cfp.config.set(portspeed_list=portspeed_list)
-            await free_module(module, False)
+            await module.config.port_speed.set(portspeed_list=portspeed_list)
+            await release_module(module, False)
             return None
     raise NotSupportPortSpeed(module)
 
 
-async def get_module_eol_date(module: GenericAnyModule) -> str:
+async def set_module_config(
+    module: t.Union[GenericL23Module, ModuleChimera],
+    media: enums.MediaConfigurationType,
+    port_count: int,
+    port_speed: int,
+    force: bool = True,
+) -> None:
+    """Change the module configuration to the target media, port count and port speed.
+
+    :param module: the module object
+    :type module: t.Union[GenericL23Module, ModuleChimera]
+    :param media: the target media for the module
+    :type media: enums.MediaConfigurationType
+    :param port_count: the target port count
+    :type port_count: int
+    :param port_speed: the target port speed in Mbps, e.g. 40000 for 40G
+    :type port_speed: int
+    :param force: should forcibly reserve the module, defaults to True
+    :type force: bool, optional
+    :raises NotSupportMediaPortSpeed: the provided media, port count and port speed configuration is not supported by the module
     """
-    .. versionadded:: 1.3
 
+    # reserve the module first
+    await reserve_module(module, force)
+
+    # get the supported media
+    supported_media_list = get_module_supported_media(module)
+
+    # set the module media if the target media is found in supported media
+    for item in supported_media_list:
+        if all(
+            (
+                item["media"] == media,
+                item["port_count"] == port_count,
+                item["port_speed"] == port_speed,
+            )
+        ):
+            portspeed_list = [port_count] + port_count * [port_speed]
+            await module.config.media.set(media_config=media)
+            await module.config.port_speed.set(portspeed_list=portspeed_list)
+            await release_module(module, False)
+            return None
+    raise NotSupportMediaPortSpeed(module)
+
+
+async def get_module_eol_date(module: GenericAnyModule) -> str:
+    """
     Get module's End-of-Life date
 
     :param module: The module object
@@ -303,8 +327,6 @@ async def get_module_eol_date(module: GenericAnyModule) -> str:
 
 async def get_module_eol_days(module: GenericAnyModule) -> int:
     """
-    .. versionadded:: 1.3
-
     Get days until module's End-of-Life date
 
     :param module: The module object
@@ -321,8 +343,6 @@ async def get_module_eol_days(module: GenericAnyModule) -> int:
 
 async def get_module_cage_insertion_count(module: Z800FreyaModule, cage_index: int) -> int:
     """
-    .. versionadded:: 2.7.2
-
     Get module cage insertion count
 
     :param module: The Z800 Freya module object
@@ -352,8 +372,6 @@ async def get_module_cage_insertion_count(module: Z800FreyaModule, cage_index: i
 
 def get_all_ports(tester: GenericAnyTester) -> tuple[GenericAnyPort, ...]:
     """
-    .. versionadded:: 1.1
-
     Get all ports of the tester
 
     :param tester: The tester object
@@ -367,8 +385,6 @@ def get_all_ports(tester: GenericAnyTester) -> tuple[GenericAnyPort, ...]:
 
 def get_ports(tester: GenericAnyTester, module_id: int) -> tuple[GenericAnyPort, ...]:
     """
-    .. versionadded:: 1.1
-
     Get all ports of the module
 
     :param tester: The tester object
@@ -384,8 +400,6 @@ def get_ports(tester: GenericAnyTester, module_id: int) -> tuple[GenericAnyPort,
 
 def get_port(tester: GenericAnyTester, module_id: int, port_id: int) -> GenericAnyPort:
     """
-    .. versionadded:: 1.1
-
     Get a port of the module
 
     :param tester: The tester object
@@ -402,10 +416,8 @@ def get_port(tester: GenericAnyTester, module_id: int, port_id: int) -> GenericA
     return module.ports.obtain(port_id)
 
 
-async def reserve_port(port: GenericAnyPort, force: bool = True) -> None:
+async def reserve_port(port: GenericAnyPort, force: bool = True, reset: bool = False) -> None:
     """
-    .. versionadded:: 1.1
-
     Reserve a port regardless whether it is owned by others or not.
 
     :param port: The port to reserve
@@ -423,27 +435,12 @@ async def reserve_port(port: GenericAnyPort, force: bool = True) -> None:
         )
     elif r.status == enums.ReservedStatus.RELEASED:
         await port.reservation.set_reserve()
+    if reset:
+        await port.reset.set()
 
 
-async def reset_port(port: GenericAnyPort) -> None:
-    """
-    .. versionadded:: 1.1
-
-    Reserve and reset a port
-
-    :param port: The port to reset
-    :type port: GenericAnyPort
-    :return:
-    :rtype: None
-    """
-    await reserve_port(port, False)
-    await port.reset.set()
-
-
-async def free_port(port: GenericAnyPort) -> None:
+async def release_port(port: GenericAnyPort) -> None:
     """
-    .. versionadded:: 1.1
-
     Free a port. If the port is reserved by you, release the port. If the port is reserved by others, relinquish the port. The port should have no owner afterwards.
 
     :param port: The port to free
@@ -458,16 +455,14 @@ async def free_port(port: GenericAnyPort) -> None:
         await port.reservation.set_release()
 
 
-async def free_ports(*ports: GenericAnyPort) -> None:
+async def release_ports(*ports: GenericAnyPort) -> None:
     """
-    .. versionadded:: 1.1
-
-    Free all ports on a module.
+    Free a list of ports. If the port is reserved by you, release the port. If the port is reserved by others, relinquish the port. The port should have no owner afterwards.
 
-    :param port: The port to free
-    :type port: GenericAnyPort
+    :param ports: The ports to free
+    :type ports: GenericAnyPort
     """
-    await asyncio.gather(*(free_port(port=p) for p in ports))
+    await asyncio.gather(*(release_port(port=p) for p in ports))
 
 
 
@@ -477,12 +472,10 @@ async def free_ports(*ports: GenericAnyPort) -> None:
 # region Streams
 async def remove_streams(port: GenericAnyPort) -> None:
     """
-    .. versionadded:: 2.1
+    Remove all streams on a port witout resetting the port.
 
-    Remove all streams on a port.
-
-    :param module: The port object
-    :type module: GenericAnyPort
+    :param port: The port object
+    :type port: GenericAnyPort
     """
     await port.streams.server_sync()
     await asyncio.gather(*(s.delete() for s in port.streams))
@@ -491,10 +484,10 @@ async def remove_streams(port: GenericAnyPort) -> None:
 # endregion
 
 __all__ = (
-    "free_module",
-    "free_port",
-    "free_ports",
-    "free_tester",
+    "release_module",
+    "release_port",
+    "release_ports",
+    "release_tester",
     "get_all_ports",
     "get_module",
     "get_module_eol_date",
@@ -506,7 +499,6 @@ __all__ = (
     "reserve_module",
     "reserve_port",
     "reserve_tester",
-    "reset_port",
     "set_module_media_config",
     "set_module_port_config",
     "remove_streams",

xoa_driver/functions/tools.py

@@ -253,4 +253,16 @@ def dictionize_anlt_log_ctrl_status(
         "fsm_lt_stimuli": _fsm_lt_stimuli,
         "fsm_lt_alg0": _fsm_lt_alg0,
         "fsm_lt_algn1": _fsm_lt_algn1,
-    }
+    }
+
+__all__ = (
+    "get_ctx",
+    "dictionize_autoneg_status",
+    "dictionize_lt_status",
+    "dictionize_txtap_get",
+    "dictionize_anlt_status",
+    "dictionize_lt_im_status",
+    "dictionize_lt_algorithm_status",
+    "MODULE_EOL_INFO",
+    "dictionize_anlt_log_ctrl_status",
+)

xoa_driver/internals/commands/c_commands.py

@@ -2039,3 +2039,29 @@ class C_MODEL_NUMBER:
         """
 
         return Token(self._connection, build_get_request(self))
+    
+
+@register_command
+@dataclass
+class C_USED_TPLDID:
+    """
+    Get the used TPLD IDs from the chassis.
+    """
+
+    code: typing.ClassVar[int] = 44
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+
+    class GetDataAttr(ResponseBodyStruct):
+        used_tpld_ids: typing.List[int] = field(XmpSequence(types_chunk=[XmpInt()]))
+        """integer list, the used TPLD IDs from the chassis."""
+
+    def get(self) -> Token[GetDataAttr]:
+        """Get the used TPLD IDs from the chassis.
+
+        :return: the used TPLD IDs from the chassis.
+        :rtype: C_USED_TPLDID.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self))

xoa_driver/internals/commands/enums.py

@@ -733,15 +733,11 @@ class PayloadType(IntEnum):
 
     INC16 = 5
     """
-    .. versionadded:: 1.1
-
     Incrementing with 0xFFFF (16-bit mode)
     """
 
     DEC16 = 6
     """
-    .. versionadded:: 1.1
-
     Decrementing with 0xFFFF (16-bit mode)
     """
 
@@ -1064,6 +1060,15 @@ class MediaConfigurationType(IntEnum):
     OSFP_NRZ = 120
     """OSFP, 56G serdes, NRZ"""
 
+    QSFP_DD_NRZ_ANLT = 121
+    """QSFP-DD, 25G serdes, L1/ANLT"""
+
+    OSFP_NRZ_ANLT = 122
+    """OSFP, 25G serdes, L1/ANLT"""
+
+    QSFP28_NRZ_ANLT = 123
+    """QSFP28, 25G serdes, L1/ANLT"""
+
     UNKNOWN = 255
 
 
@@ -2278,8 +2283,6 @@ class LinkTrainingFailureType(IntEnum):
 
 class Layer1ConfigType(IntEnum):
     """
-    .. versionadded:: 1.1
-
     Enums for PL1_CFG_TMP's type.
     """
 
@@ -2314,8 +2317,6 @@ class Layer1ConfigType(IntEnum):
 class Layer1LogType(IntEnum):
     """
 
-    .. versionadded:: 1.1
-
     .. warning::
 
         Still in beta mode. Subjected to changes
@@ -2332,10 +2333,7 @@ class Layer1LogType(IntEnum):
 
 class LinkTrainAlgorithm(IntEnum):
     """
-    .. versionadded:: 1.2
-
     Link Training Algorithm
-
     """
 
     INTERACTIVE = 0
@@ -2350,8 +2348,6 @@ class LinkTrainAlgorithm(IntEnum):
 
 class LinkTrainCmd(IntEnum):
     """
-    .. versionadded:: 1.1
-
     Link Training commands
 
     """
@@ -2380,8 +2376,6 @@ class LinkTrainCmd(IntEnum):
 
 class LinkTrainPresets(IntEnum):
     """
-    .. versionadded:: 1.1
-
     Link Training presets
 
     """
@@ -2407,8 +2401,6 @@ class LinkTrainPresets(IntEnum):
 
 class LinkTrainCoeffs(IntEnum):
     """
-    .. versionadded:: 1.1
-
 
     Link Training coefficients
 
@@ -2435,8 +2427,6 @@ class LinkTrainCoeffs(IntEnum):
 
 class LinkTrainEncoding(IntEnum):
     """
-    .. versionadded:: 1.1
-
     Link Training Encoding
 
     """
@@ -2456,8 +2446,6 @@ class LinkTrainEncoding(IntEnum):
 
 class LinkTrainCmdResults(IntEnum):
     """
-    .. versionadded:: 1.1
-
     Link Training Command Results
 
     """
@@ -2495,8 +2483,6 @@ class LinkTrainCmdResults(IntEnum):
 
 class LinkTrainCmdFlags(IntEnum):
     """
-    .. versionadded:: 1.1
-
     Link Training Command Flags
 
     """
@@ -2522,8 +2508,6 @@ class LinkTrainCmdFlags(IntEnum):
 
 class LinkTrainAnnounce(IntEnum):
     """
-    .. versionadded:: 1.1
-
     Link Training Announce
 
     """
@@ -2534,8 +2518,6 @@ class LinkTrainAnnounce(IntEnum):
 
 class AnLtLogControl(IntEnum):
     """
-    .. versionadded:: 1.3
-
     ANLT log control bits
 
     """
@@ -3198,6 +3180,12 @@ class ModuleModelName(IntEnum):
     Z_800_Q_FREYA   = 10
     Z_800_O_FREYA   = 11
     E_100_Q_CHIMERA = 12
+
+class ModuleConfigStatus(IntEnum):
+    UNKNOWN = 0
+    SUCCESS = 1
+    PROGRESSING = 2
+    FAILED = 3
     
 # endregion
 
@@ -3264,8 +3252,8 @@ class MACSecRekeyMode(IntEnum):
     PN_EXHAUSTION = 0
     """Switch to the next SAK when PN is exhausted."""
 
-    PACKET_CNT = 1
-    """Switch to the next SAK when the given number of packets are transmitted."""
+    PACKET_NUMBER = 1
+    """Switch to the next SAK when the given packet number is transmitted."""
 
 
 class MACSecEncryptionMode(IntEnum):

xoa_driver/internals/commands/m_commands.py

@@ -45,7 +45,8 @@ from .enums import (
     ImpairmentLatencyMode,
     PPMSweepStatus,
     PPMSweepMode,
-    ModuleModelName
+    ModuleModelName,
+    ModuleConfigStatus,
 )
 
 
@@ -1605,8 +1606,6 @@ class M_TXCLOCKFILTER_NEW:
 @dataclass
 class M_CLOCKPPBSWEEP:
     """
-    .. versionadded:: 1.1
-
     Start and stop deviation sweep the local clock of the test module, which drives the TX rate of the test ports.
 
     Note: The sweep is independent of the :class:`M_CLOCKPPB` parameter, i.e. the sweep uses the deviation set by :class:`M_CLOCKPPB` as its zero point.
@@ -1685,8 +1684,6 @@ class M_CLOCKPPBSWEEP:
 @dataclass
 class M_CLOCKSWEEPSTATUS:
     """
-    .. versionadded:: 1.1
-
     Return the current status of the :class:`M_CLOCKPPBSWEEP` function.
 
     """
@@ -1863,13 +1860,44 @@ class M_MODEL_NAME:
 
     class GetDataAttr(ResponseBodyStruct):
         name:  ModuleModelName = field(XmpInt())
-        """ModuleModelName, model name of the Xena module."""
+        """Module Model Name, model name of the Xena module."""
 
     def get(self) -> Token[GetDataAttr]:
         """Get the Xena chassis model name.
 
         :return: the model name of the Xena tester
-        :rtype: C_MODEL_NAME.GetDataAttr
+        :rtype: M_MODEL_NAME.GetDataAttr
         """
 
         return Token(self._connection, build_get_request(self, module=self._module))
+
+
+@register_command
+@dataclass
+class M_RECONFIG_STATUS:
+    """
+    Show the test module configuration status when the user has configured the test module to a different configuration than the one it is currently running. 
+    """
+
+    code: typing.ClassVar[int] = 399
+    pushed: typing.ClassVar[bool] = False
+
+    _connection: 'interfaces.IConnection'
+    _module: int
+
+    class GetDataAttr(ResponseBodyStruct):
+        status:  ModuleConfigStatus = field(XmpByte())
+        """Module configuration status."""
+
+        progress: int = field(XmpInt())
+        """Progress in units of 0.1%, i.e. valid range 0-1000. Increments are module-specific, the value may in some cases jump directly from 0 to 1000, or in other cases progress more smoothly.
+        """
+
+    def get(self) -> Token[GetDataAttr]:
+        """Show the test module configuration status when the user has configured the test module to a different configuration than the one it is currently running.
+
+        :return: the model name of the Xena tester
+        :rtype: M_RECONFIG_STATUS.GetDataAttr
+        """
+
+        return Token(self._connection, build_get_request(self, module=self._module))