Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add get_transceiver_status and get_transceiver_pm to API interface #315

Merged
merged 6 commits into from
Dec 6, 2022
Merged

Add get_transceiver_status and get_transceiver_pm to API interface #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5752d7e
Add get_transceiver_status to API interface
longhuan-cisco Oct 11, 2022
0736d15
Add test_ccmis support
longhuan-cisco Oct 27, 2022
35170fd
Add get_transceiver_pm API interface
longhuan-cisco Oct 27, 2022
542e67d
Merge pull request #2 from longhuan-cisco/add_pm_tbl_dep
longhuan-cisco Nov 8, 2022
5261da7
Add debug log and more description for interface
longhuan-cisco Nov 23, 2022
0369b0c
Remove unnecessary pass
longhuan-cisco Nov 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions sonic_platform_base/sonic_xcvr/api/public/c_cmis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@

Implementation of XcvrApi that corresponds to C-CMIS
"""
from sonic_py_common import logger
from ...fields import consts
from .cmis import CmisApi
import time
BYTELENGTH = 8
VDM_FREEZE = 128
VDM_UNFREEZE = 0
SYSLOG_IDENTIFIER = "CCmisApi"

helper_logger = logger.Logger(SYSLOG_IDENTIFIER)

class CCmisApi(CmisApi):
def __init__(self, xcvr_eeprom):
Expand Down Expand Up @@ -183,7 +187,7 @@ def get_pm_all(self):
rx_frames_subint_pm = self.xcvr_eeprom.read(consts.RX_FRAMES_SUB_INTERVAL_PM)
rx_frames_uncorr_err_pm = self.xcvr_eeprom.read(consts.RX_FRAMES_UNCORR_ERR_PM)
rx_min_frames_uncorr_err_subint_pm = self.xcvr_eeprom.read(consts.RX_MIN_FRAMES_UNCORR_ERR_SUB_INTERVAL_PM)
rx_max_frames_uncorr_err_subint_pm = self.xcvr_eeprom.read(consts.RX_MIN_FRAMES_UNCORR_ERR_SUB_INTERVAL_PM)
rx_max_frames_uncorr_err_subint_pm = self.xcvr_eeprom.read(consts.RX_MAX_FRAMES_UNCORR_ERR_SUB_INTERVAL_PM)

if (rx_frames_subint_pm != 0) and (rx_frames_pm != 0):
PM_dict['preFEC_uncorr_frame_ratio_avg'] = rx_frames_uncorr_err_pm*1.0/rx_frames_subint_pm
Expand Down Expand Up @@ -571,8 +575,6 @@ def get_transceiver_status(self):
================================================================================
key = TRANSCEIVER_STATUS|ifname ; Error information for module on port
; field = value
status = 1*255VCHAR ; code of the module status (plug in, plug out)
error = 1*255VCHAR ; module error (N/A or a string consisting of error descriptions joined by "|", like "error1 | error2" )
module_state = 1*255VCHAR ; current module state (ModuleLowPwr, ModulePwrUp, ModuleReady, ModulePwrDn, Fault)
module_fault_cause = 1*255VCHAR ; reason of entering the module fault state
datapath_firmware_fault = BOOLEAN ; datapath (DSP) firmware fault
Expand Down Expand Up @@ -818,10 +820,13 @@ def get_transceiver_status(self):
trans_status['rxtotpowerlowalarm_flag'] = self.vdm_dict['Rx Total Power [dBm]'][1][6]
trans_status['rxtotpowerhighwarning_flag'] = self.vdm_dict['Rx Total Power [dBm]'][1][7]
trans_status['rxtotpowerlowwarning_flag'] = self.vdm_dict['Rx Total Power [dBm]'][1][8]
trans_status['rxsigpowerhighalarm_flag'] = self.vdm_dict['Rx Signal Power [dBm]'][1][5]
trans_status['rxsigpowerlowalarm_flag'] = self.vdm_dict['Rx Signal Power [dBm]'][1][6]
trans_status['rxsigpowerhighwarning_flag'] = self.vdm_dict['Rx Signal Power [dBm]'][1][7]
trans_status['rxsigpowerlowwarning_flag'] = self.vdm_dict['Rx Signal Power [dBm]'][1][8]
try:
trans_status['rxsigpowerhighalarm_flag'] = self.vdm_dict['Rx Signal Power [dBm]'][1][5]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious - Are we seeing KeyError exception for ZR since I didn't find this being populated in the UT.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes.
And I saw similar key error handling in c_cmis.py:get_transceiver_threshold_info() for self.vdm_dict['Rx Signal Power [dBm]']

trans_status['rxsigpowerlowalarm_flag'] = self.vdm_dict['Rx Signal Power [dBm]'][1][6]
trans_status['rxsigpowerhighwarning_flag'] = self.vdm_dict['Rx Signal Power [dBm]'][1][7]
trans_status['rxsigpowerlowwarning_flag'] = self.vdm_dict['Rx Signal Power [dBm]'][1][8]
except KeyError:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@longhuan-cisco how do we know if there is a key error?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a debug log here in the case of key error.

helper_logger.log_debug('Rx Signal Power [dBm] not present in VDM')
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will the 'debug' level log print out in the running time?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we print more generic key error that can print any Key error name?

return trans_status

def get_transceiver_pm(self):
Expand Down
2 changes: 0 additions & 2 deletions sonic_platform_base/sonic_xcvr/api/public/cmis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1554,8 +1554,6 @@ def get_transceiver_status(self):
================================================================================
key = TRANSCEIVER_STATUS|ifname ; Error information for module on port
; field = value
status = 1*255VCHAR ; code of the module status (plug in, plug out)
error = 1*255VCHAR ; module error (N/A or a string consisting of error descriptions joined by "|", like "error1 | error2" )
module_state = 1*255VCHAR ; current module state (ModuleLowPwr, ModulePwrUp, ModuleReady, ModulePwrDn, Fault)
module_fault_cause = 1*255VCHAR ; reason of entering the module fault state
datapath_firmware_fault = BOOLEAN ; datapath (DSP) firmware fault
Expand Down
157 changes: 157 additions & 0 deletions sonic_platform_base/sonic_xcvr/api/xcvr_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,163 @@ def get_transceiver_threshold_info(self):
"""
raise NotImplementedError

def get_transceiver_status(self):
"""
Retrieves transceiver status of this SFP (applicable for CMIS/C-CMIS)

Returns:
A dict which may contain following keys/values (there could be more for C-CMIS) :
================================================================================
key = TRANSCEIVER_STATUS|ifname ; Error information for module on port
; field = value
module_state = 1*255VCHAR ; current module state (ModuleLowPwr, ModulePwrUp, ModuleReady, ModulePwrDn, Fault)
module_fault_cause = 1*255VCHAR ; reason of entering the module fault state
datapath_firmware_fault = BOOLEAN ; datapath (DSP) firmware fault
module_firmware_fault = BOOLEAN ; module firmware fault
module_state_changed = BOOLEAN ; module state changed
datapath_hostlane1 = 1*255VCHAR ; data path state indicator on host lane 1
datapath_hostlane2 = 1*255VCHAR ; data path state indicator on host lane 2
datapath_hostlane3 = 1*255VCHAR ; data path state indicator on host lane 3
datapath_hostlane4 = 1*255VCHAR ; data path state indicator on host lane 4
datapath_hostlane5 = 1*255VCHAR ; data path state indicator on host lane 5
datapath_hostlane6 = 1*255VCHAR ; data path state indicator on host lane 6
datapath_hostlane7 = 1*255VCHAR ; data path state indicator on host lane 7
datapath_hostlane8 = 1*255VCHAR ; data path state indicator on host lane 8
txoutput_status = BOOLEAN ; tx output status on media lane
rxoutput_status_hostlane1 = BOOLEAN ; rx output status on host lane 1
rxoutput_status_hostlane2 = BOOLEAN ; rx output status on host lane 2
rxoutput_status_hostlane3 = BOOLEAN ; rx output status on host lane 3
rxoutput_status_hostlane4 = BOOLEAN ; rx output status on host lane 4
rxoutput_status_hostlane5 = BOOLEAN ; rx output status on host lane 5
rxoutput_status_hostlane6 = BOOLEAN ; rx output status on host lane 6
rxoutput_status_hostlane7 = BOOLEAN ; rx output status on host lane 7
rxoutput_status_hostlane8 = BOOLEAN ; rx output status on host lane 8
txfault = BOOLEAN ; tx fault flag on media lane
txlos_hostlane1 = BOOLEAN ; tx loss of signal flag on host lane 1
txlos_hostlane2 = BOOLEAN ; tx loss of signal flag on host lane 2
txlos_hostlane3 = BOOLEAN ; tx loss of signal flag on host lane 3
txlos_hostlane4 = BOOLEAN ; tx loss of signal flag on host lane 4
txlos_hostlane5 = BOOLEAN ; tx loss of signal flag on host lane 5
txlos_hostlane6 = BOOLEAN ; tx loss of signal flag on host lane 6
txlos_hostlane7 = BOOLEAN ; tx loss of signal flag on host lane 7
txlos_hostlane8 = BOOLEAN ; tx loss of signal flag on host lane 8
txcdrlol_hostlane1 = BOOLEAN ; tx clock and data recovery loss of lock on host lane 1
txcdrlol_hostlane2 = BOOLEAN ; tx clock and data recovery loss of lock on host lane 2
txcdrlol_hostlane3 = BOOLEAN ; tx clock and data recovery loss of lock on host lane 3
txcdrlol_hostlane4 = BOOLEAN ; tx clock and data recovery loss of lock on host lane 4
txcdrlol_hostlane5 = BOOLEAN ; tx clock and data recovery loss of lock on host lane 5
txcdrlol_hostlane6 = BOOLEAN ; tx clock and data recovery loss of lock on host lane 6
txcdrlol_hostlane7 = BOOLEAN ; tx clock and data recovery loss of lock on host lane 7
txcdrlol_hostlane8 = BOOLEAN ; tx clock and data recovery loss of lock on host lane 8
rxlos = BOOLEAN ; rx loss of signal flag on media lane
rxcdrlol = BOOLEAN ; rx clock and data recovery loss of lock on media lane
config_state_hostlane1 = 1*255VCHAR ; configuration status for the data path of host line 1
config_state_hostlane2 = 1*255VCHAR ; configuration status for the data path of host line 2
config_state_hostlane3 = 1*255VCHAR ; configuration status for the data path of host line 3
config_state_hostlane4 = 1*255VCHAR ; configuration status for the data path of host line 4
config_state_hostlane5 = 1*255VCHAR ; configuration status for the data path of host line 5
config_state_hostlane6 = 1*255VCHAR ; configuration status for the data path of host line 6
config_state_hostlane7 = 1*255VCHAR ; configuration status for the data path of host line 7
config_state_hostlane8 = 1*255VCHAR ; configuration status for the data path of host line 8
dpinit_pending_hostlane1 = BOOLEAN ; data path configuration updated on host lane 1
dpinit_pending_hostlane2 = BOOLEAN ; data path configuration updated on host lane 2
dpinit_pending_hostlane3 = BOOLEAN ; data path configuration updated on host lane 3
dpinit_pending_hostlane4 = BOOLEAN ; data path configuration updated on host lane 4
dpinit_pending_hostlane5 = BOOLEAN ; data path configuration updated on host lane 5
dpinit_pending_hostlane6 = BOOLEAN ; data path configuration updated on host lane 6
dpinit_pending_hostlane7 = BOOLEAN ; data path configuration updated on host lane 7
dpinit_pending_hostlane8 = BOOLEAN ; data path configuration updated on host lane 8
temphighalarm_flag = BOOLEAN ; temperature high alarm flag
temphighwarning_flag = BOOLEAN ; temperature high warning flag
templowalarm_flag = BOOLEAN ; temperature low alarm flag
templowwarning_flag = BOOLEAN ; temperature low warning flag
vcchighalarm_flag = BOOLEAN ; vcc high alarm flag
vcchighwarning_flag = BOOLEAN ; vcc high warning flag
vcclowalarm_flag = BOOLEAN ; vcc low alarm flag
vcclowwarning_flag = BOOLEAN ; vcc low warning flag
txpowerhighalarm_flag = BOOLEAN ; tx power high alarm flag
txpowerlowalarm_flag = BOOLEAN ; tx power low alarm flag
txpowerhighwarning_flag = BOOLEAN ; tx power high warning flag
txpowerlowwarning_flag = BOOLEAN ; tx power low alarm flag
rxpowerhighalarm_flag = BOOLEAN ; rx power high alarm flag
rxpowerlowalarm_flag = BOOLEAN ; rx power low alarm flag
rxpowerhighwarning_flag = BOOLEAN ; rx power high warning flag
rxpowerlowwarning_flag = BOOLEAN ; rx power low warning flag
txbiashighalarm_flag = BOOLEAN ; tx bias high alarm flag
txbiaslowalarm_flag = BOOLEAN ; tx bias low alarm flag
txbiashighwarning_flag = BOOLEAN ; tx bias high warning flag
txbiaslowwarning_flag = BOOLEAN ; tx bias low warning flag
lasertemphighalarm_flag = BOOLEAN ; laser temperature high alarm flag
lasertemplowalarm_flag = BOOLEAN ; laser temperature low alarm flag
lasertemphighwarning_flag = BOOLEAN ; laser temperature high warning flag
lasertemplowwarning_flag = BOOLEAN ; laser temperature low warning flag
prefecberhighalarm_flag = BOOLEAN ; prefec ber high alarm flag
prefecberlowalarm_flag = BOOLEAN ; prefec ber low alarm flag
prefecberhighwarning_flag = BOOLEAN ; prefec ber high warning flag
prefecberlowwarning_flag = BOOLEAN ; prefec ber low warning flag
postfecberhighalarm_flag = BOOLEAN ; postfec ber high alarm flag
postfecberlowalarm_flag = BOOLEAN ; postfec ber low alarm flag
postfecberhighwarning_flag = BOOLEAN ; postfec ber high warning flag
postfecberlowwarning_flag = BOOLEAN ; postfec ber low warning flag
================================================================================

If there is an issue with reading the xcvr, None should be returned.
"""
raise NotImplementedError

def get_transceiver_pm(self):
"""
Retrieves PM (Performance Monitoring) info for this xcvr (applicable for C-CMIS)

Returns:
A dict containing the following keys/values :
========================================================================
key = TRANSCEIVER_PM|ifname ; information of PM on port
; field = value
prefec_ber_avg = FLOAT ; prefec ber avg
prefec_ber_min = FLOAT ; prefec ber min
prefec_ber_max = FLOAT ; prefec ber max
uncorr_frames_avg = FLOAT ; uncorrected frames ratio avg
uncorr_frames_min = FLOAT ; uncorrected frames ratio min
uncorr_frames_max = FLOAT ; uncorrected frames ratio max
cd_avg = FLOAT ; chromatic dispersion avg
cd_min = FLOAT ; chromatic dispersion min
cd_max = FLOAT ; chromatic dispersion max
dgd_avg = FLOAT ; differential group delay avg
dgd_min = FLOAT ; differential group delay min
dgd_max = FLOAT ; differential group delay max
sopmd_avg = FLOAT ; second order polarization mode dispersion avg
sopmd_min = FLOAT ; second order polarization mode dispersion min
sopmd_max = FLOAT ; second order polarization mode dispersion max
pdl_avg = FLOAT ; polarization dependent loss avg
pdl_min = FLOAT ; polarization dependent loss min
pdl_max = FLOAT ; polarization dependent loss max
osnr_avg = FLOAT ; optical signal to noise ratio avg
osnr_min = FLOAT ; optical signal to noise ratio min
osnr_max = FLOAT ; optical signal to noise ratio max
esnr_avg = FLOAT ; electrical signal to noise ratio avg
esnr_min = FLOAT ; electrical signal to noise ratio min
esnr_max = FLOAT ; electrical signal to noise ratio max
cfo_avg = FLOAT ; carrier frequency offset avg
cfo_min = FLOAT ; carrier frequency offset min
cfo_max = FLOAT ; carrier frequency offset max
soproc_avg = FLOAT ; state of polarization rate of change avg
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@longhuan-cisco 'evm_min/avg/max' is missing

soproc_min = FLOAT ; state of polarization rate of change min
soproc_max = FLOAT ; state of polarization rate of change max
tx_power_avg = FLOAT ; tx output power avg
tx_power_min = FLOAT ; tx output power min
tx_power_max = FLOAT ; tx output power max
rx_tot_power_avg = FLOAT ; rx total power avg
rx_tot_power_min = FLOAT ; rx total power min
rx_tot_power_max = FLOAT ; rx total power max
rx_sig_power_avg = FLOAT ; rx signal power avg
rx_sig_power_min = FLOAT ; rx signal power min
rx_sig_power_max = FLOAT ; rx signal power max

If there is an issue with reading the xcvr, None should be returned.
"""
raise NotImplementedError

def get_rx_los(self):
"""
Retrieves the RX LOS (loss-of-signal) status of this xcvr
Expand Down
Loading