Transceiver CLI changes to support DOM and STATUS table related changes by mihirpat1 · Pull Request #3844 · sonic-net/sonic-utilities

mihirpat1 · 2025-04-10T02:27:15Z

What I did

With the recent transceiver DOM and STATUS table related changes, the handles of the following CLIs need to be modified to ensure that the CLI function inline to the existing behavior
1. show int transceiver eeprom -d
2. show int transceiver status
3. show int transceiver pm
4. sfputil show eeprom -d -p EthernetXX
Also, all the diagnostics related tables will not be present only for the first subport for breakout ports. Hence, made the corresponding CLI handler related changes to support this
Modified the sfputil show error-status CLI handler to use TRANSCEIVER_STATUS_SW instead of TRANSCEIVER_STATUS table

How I did it

Replaced function call for get_transceiver_bulk_status with get_transceiver_dom_real_value
As part of displaying o/p for "show int transceiver status" CLI, we are now fetching data from TRANSCEIVER_DOM_FLAG, VDM flag tables and TRANSCEIVER_STATUS_FLAG tables as well since the relevant fields have been moved to these new tables
As part of display o/p for "show int transceiver pm" CLI, we are now fetching data from VDM threshold tables as well since the relevant fields have been moved to these new tables

Related PRs
sonic-net/SONiC#1954
[cmis] Separate Flag-Specific Fields for DOM and Status APIs by mihirpat1 · Pull Request #556 · sonic-net/sonic-platform-common
[xcvrd] Re-organize transceiver DOM and STATUS tables by mihirpat1 · Pull Request #604 · sonic-net/sonic-platform-daemons

How to verify it

Following tests were attempted and confirmed to pass

Diagnostic table related verification
1. Compare tables with nightly image and ensure non-CMIS transceivers do not change their mapping for DOM and status tables
2. Compare DOM sensor, threshold and status tables between current and nightly. Ensure units are not shown
3. Dump TRANSCEIVER_INFO table for CMIS transceiver to ensure is_replaceable field is present
CLI verification
1. sudo sfputil show error-status - This should dump output for all the ports and the behavior should not change between nightly and private image
2. Use invalid port name (Ethernet2033) to dump show int transceiver info, status CLI. Ensure to note new errors in PR description for invalid ports
3. For breakout scenario, keep 2 subports in different CMIS_STATES and ensure the CLI o/p is different for status CLI for both subports
Run transceiver onboarding test due to TRANSCEIVER_INFO table deletion change
XCVRD stop/start
1. Stop xcvrd and ensure all diagnostic tables are deleted
2. Start xcvrd and ensure all diagnostic tables are populated
Link flap event handling
1. Change link flap count for different types of transceivers and ensure no crash is seen. This is to ensure that the link event handler code does not cause any crash for non-CMIS transceivers
2. Shutdown peer port and ensure the tables get updated which are handled via link event update handler.
  Also, execute sfputil reset on 10 different physical ports and ensure that all the corresponding flags on the remote side are updated for all 8 lanes of a DR8 optic
  Specifically, we need to ensure that the following flags are set wherein X represents the lane number
  1. LOSFlagRxX (page 11, byte 147)
  2. CDRLOLFlagRxX (page 11, byte 148)
  3. OpticalPowerLowAlarmFlagRxX (page 11, byte 150)
  4. OpticalPowerLowWarningFlagRxX (page 11, byte 152)
Transceiver OIR test
1. Remove transceiver and ensure all diagnostic related tables are deleted
2. Insert transceiver and ensure all diagnostic tables are populated
3. Stop xcvrd and remove transceiver and ensure TRANSCEIVER_INFO table is present. Start xcvrd and ensure that the TRANSCEIVER_INFO table is now deleted
4. Insert the transceiver now
Ensure firmware upgrade is successfull and TRANSCEIVER_FIRMWARE_INFO table changes only for the primary subport eventhough, the upgrade was triggered for a non-primary subport
Ensure SFF manager crash is seen with nightly and is resolved with this PR (since the PR has the fix for SffLoggerForPortUpdateEvent class does not have log_debug function · Issue #605 · sonic-net/sonic-platform-daemons)

Previous command output (if the output of a command-line utility has changed)

The output of show int transceiver info and show int transceiver eeprom will change if an invalid port name is passed to the CLI

root@str4-sn5600-3:/home/admin# show int transceiver info Ethernet8
Ethernet8: SFP EEPROM Not detected
root@str4-sn5600-3:/home/admin#

New command output (if the output of a command-line utility has changed)

root@str4-sn5600-3:/home/admin# show int transceiver info Ethernet8
Error: Found KeyError while getting first subport for Ethernet8
Error: Unable to get first subport for Ethernet8 while converting SFP info
Ethernet8: SFP EEPROM Not detected
root@str4-sn5600-3:/home/admin#

MSFT ADO - 32238285

Signed-off-by: Mihir Patel <[email protected]>

mssonicbld · 2025-04-10T02:27:23Z

/azp run

Copilot

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

utilities_common/sfp_helper.py:61

The naming convention for transceiver fault keys has changed from 'txfault{n}' to 'tx{n}fault'. Please ensure that all consuming code and CLI output functions are updated consistently to handle the new key names.

    'tx1fault': 'Tx fault flag on media lane 1',

utilities_common/sfp_helper.py:397

[nitpick] There appears to be a typo in the function name: 'covert' might be intended as 'convert' for clarity and accuracy.

def covert_application_advertisement_to_output_string(indent, sfp_info_dict):

azure-pipelines · 2025-04-10T02:27:34Z

Azure Pipelines successfully started running 1 pipeline(s).

…added support for TRANSCEIVER_STATUS_SW table

mssonicbld · 2025-04-15T16:13:00Z

/azp run

azure-pipelines · 2025-04-15T16:13:10Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-04-15T16:24:17Z

/azp run

azure-pipelines · 2025-04-15T16:24:28Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

sfputil/main.py:546

There is an inconsistency in the use of the port identifier: while most queries use 'first_subport', this update uses 'interface_name'. Please verify that this mixed usage is intentional and does not lead to mismatched data retrieval.

sfp_status_dict.update(state_db.get_all(state_db.STATE_DB, 'TRANSCEIVER_STATUS_SW|{}'.format(interface_name)) or {})

sfputil/main.py:490

Consider adding unit tests for the 'convert_vdm_fields_to_legacy_fields' function to ensure robust handling of both 'FLAG' and 'THRESHOLD' VDM field types.

def convert_vdm_fields_to_legacy_fields(self, state_db, interface_name, dict_to_be_updated, vdm_to_legacy_field_map, vdm_field_type):

…cked STATE_DB

mssonicbld · 2025-04-15T17:23:11Z

/azp run

azure-pipelines · 2025-04-15T17:23:22Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-04-16T03:16:14Z

/azp run

azure-pipelines · 2025-04-16T03:16:25Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-04-16T04:00:20Z

/azp run

azure-pipelines · 2025-04-16T04:01:15Z

Azure Pipelines successfully started running 1 pipeline(s).

…es (sonic-net#3844) * Transceiver CLI changes to support DOM and STATUS table related changes Signed-off-by: Mihir Patel <[email protected]> * Added details to convert_vdm_fields_to_legacy_fields * Fixed pre-commit check * Added CLI support to access diagnostic tables from primary subport + added support for TRANSCEIVER_STATUS_SW table * Fix pre-commit check * Fixed unit-test failure by adding TRANSCEIVER_STATUS_SW as part of mocked STATE_DB * Fixed ycable failure due to TRANSCEIVER_STATUS related change * Modified update_firmware_info_to_state_db to update DB for first subport * Increased code coverage for update_firmware_info_to_state_db * Added test_show_eeprom_dom_real_value_exception --------- Signed-off-by: Mihir Patel <[email protected]>

mssonicbld · 2025-05-09T07:29:46Z

Cherry-pick PR to msft-202412: Azure/sonic-utilities.msft#176

#### Description  The DOM and Status related APIs need to be modified to ensure that the fields which have latched registers are moved to the flag specific API. Also, all the VDM specific fields have now been removed from DOM and Status related APIs since separate APIs pertaining to processing VDM data have now been created. This change is in line to the requirements of [SONiC/doc/platform_api/CMIS_Diagnostic_Monitoring_Overview_in_SONiC.md at master · sonic-net/SONiC](https://github.com/sonic-net/SONiC/blob/master/doc/platform_api/CMIS_Diagnostic_Monitoring_Overview_in_SONiC.md) #### Motivation and Context  N/A #### How Has This Been Tested?  Please refer to sonic-net/sonic-utilities#3844 for the test details #### Additional Information (Optional) MSFT ADO - 30090754 Related PRs sonic-net/SONiC#1954 sonic-net/sonic-platform-daemons#604 sonic-net/sonic-utilities#3844

The changes to the sonic-mgmt testcases are required due to the below changes: sonic-net/sonic-platform-common#556 sonic-net/sonic-platform-daemons#604 sonic-net/sonic-utilities#3844 This PR also reverts the changes made by #181 .

…es (sonic-net#3844) * Transceiver CLI changes to support DOM and STATUS table related changes Signed-off-by: Mihir Patel <[email protected]> * Added details to convert_vdm_fields_to_legacy_fields * Fixed pre-commit check * Added CLI support to access diagnostic tables from primary subport + added support for TRANSCEIVER_STATUS_SW table * Fix pre-commit check * Fixed unit-test failure by adding TRANSCEIVER_STATUS_SW as part of mocked STATE_DB * Fixed ycable failure due to TRANSCEIVER_STATUS related change * Modified update_firmware_info_to_state_db to update DB for first subport * Increased code coverage for update_firmware_info_to_state_db * Added test_show_eeprom_dom_real_value_exception --------- Signed-off-by: Mihir Patel <[email protected]>

yejianquan · 2025-07-14T02:37:50Z

Hi @mihirpat1 , please fix conflict and create PR to 202505 branch

yejianquan · 2025-07-14T06:54:28Z

202505 branched out around 5/16, this commit is included when created, removing request labels.
and please ignore the conflict notification

mihirpat1 added 3 commits April 10, 2025 01:52

Transceiver CLI changes to support DOM and STATUS table related changes

9db2686

Signed-off-by: Mihir Patel <[email protected]>

Added details to convert_vdm_fields_to_legacy_fields

6362b94

Fixed pre-commit check

9064a01

mihirpat1 requested a review from Copilot April 10, 2025 02:27

Copilot AI reviewed Apr 10, 2025

View reviewed changes

mihirpat1 added the Request for msft-202412 Branch label Apr 10, 2025

mihirpat1 mentioned this pull request Apr 10, 2025

HLD for diagnostic monitoring of CMIS based transceivers sonic-net/SONiC#1828

Merged

mihirpat1 requested a review from prgeor April 10, 2025 02:35

Added CLI support to access diagnostic tables from primary subport + …

cb37dff

…added support for TRANSCEIVER_STATUS_SW table

Fix pre-commit check

b7d24e1

mihirpat1 requested a review from Copilot April 15, 2025 16:26

Copilot AI reviewed Apr 15, 2025

View reviewed changes

Fixed unit-test failure by adding TRANSCEIVER_STATUS_SW as part of mo…

8a4419a

…cked STATE_DB

mihirpat1 force-pushed the dom_status_cli_parity branch from ede1c33 to e87981a Compare April 16, 2025 04:00

Fixed ycable failure due to TRANSCEIVER_STATUS related change

b9f63c3

mihirpat1 force-pushed the dom_status_cli_parity branch from e87981a to b9f63c3 Compare April 16, 2025 04:33

prgeor approved these changes May 6, 2025

View reviewed changes

prgeor merged commit 05abc9e into sonic-net:master May 6, 2025
7 checks passed

r12f added the Approved for msft-202412 Branch label May 9, 2025

mssonicbld mentioned this pull request May 9, 2025

[action] [PR:3844] Transceiver CLI changes to support DOM and STATUS table related changes Azure/sonic-utilities.msft#176

Merged

mssonicbld added the Created PR to msft-202412 Branch label May 9, 2025

mssonicbld mentioned this pull request May 9, 2025

[action] [PR:556] [cmis] Separate Flag-Specific Fields for DOM and Status APIs Azure/sonic-platform-common.msft#82

Merged

mssonicbld added Included in msft-202412 Branch and removed Created PR to msft-202412 Branch labels May 9, 2025

az-pz mentioned this pull request Jun 11, 2025

Fix txvr tests after diagnostic table restructuring sonic-net/sonic-mgmt#18938

Merged

11 tasks

mihirpat1 added the Request for msft-202503 Branch label Jun 16, 2025

mssonicbld added the Cherry Pick Conflict_msft-202503 label Jun 16, 2025

This was referenced Jun 19, 2025

[202503] Fix txvr tests after diagnostic table restructuring Azure/sonic-mgmt.msft#422

Merged

[202412] Fix txvr tests after diagnostic table restructuring Azure/sonic-mgmt.msft#424

Merged

arlakshm added the Approved for msft-202503 Branch label Jun 24, 2025

az-pz mentioned this pull request Jun 27, 2025

Bug: For QSFP28 100G transceiver module, 'vdm_supported' key is missing from platform API sonic-net/sonic-buildimage#23012

Open

mihirpat1 mentioned this pull request Jul 8, 2025

[202411] DOM enhancement changes for transceiver CLIs #3957

Closed

r12f added the Request for 202505 Branch label Jul 12, 2025

mssonicbld added the Cherry Pick Conflict_202505 label Jul 12, 2025

yejianquan added the Approved for 202505 Branch label Jul 14, 2025

yejianquan removed Request for 202505 Branch Approved for 202505 Branch Cherry Pick Conflict_202505 labels Jul 14, 2025

Conversation

mihirpat1 commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

How I did it

How to verify it

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

Uh oh!

mssonicbld commented Apr 10, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

azure-pipelines bot commented Apr 10, 2025

Uh oh!

mssonicbld commented Apr 15, 2025

Uh oh!

azure-pipelines bot commented Apr 15, 2025

Uh oh!

mssonicbld commented Apr 15, 2025

Uh oh!

azure-pipelines bot commented Apr 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Apr 15, 2025

Uh oh!

azure-pipelines bot commented Apr 15, 2025

Uh oh!

mssonicbld commented Apr 16, 2025

Uh oh!

azure-pipelines bot commented Apr 16, 2025

Uh oh!

mssonicbld commented Apr 16, 2025

Uh oh!

azure-pipelines bot commented Apr 16, 2025

Uh oh!

Uh oh!

mssonicbld commented May 9, 2025

Uh oh!

yejianquan commented Jul 14, 2025

Uh oh!

yejianquan commented Jul 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

mihirpat1 commented Apr 10, 2025 •

edited

Loading