diff --git a/doc/platform_api/CMIS_and_C-CMIS_support_for_ZR.md b/doc/platform_api/CMIS_and_C-CMIS_support_for_ZR.md index c4624814298..2fb642d08fd 100644 --- a/doc/platform_api/CMIS_and_C-CMIS_support_for_ZR.md +++ b/doc/platform_api/CMIS_and_C-CMIS_support_for_ZR.md @@ -1632,3 +1632,333 @@ def write_cdb(port,cmd): write_reg(port, LPLPAGE, INIT_OFFSET+CMDLEN, len(cmd)-CMDLEN, cmd[CMDLEN:]) write_reg(port, LPLPAGE, INIT_OFFSET, CMDLEN, cmd[:CMDLEN]) ``` + +### 7.Performance Monitoring - 400-G ZR module +#### 7.1 Overview +Performance monitoring in 400G ZR/CCMIS optical modules is essential for detecting link degradation and correction. It involves measuring and analyzing various parameters of the optical signal, such as its power, wavelength, polarization, and phase. By monitoring these parameters, operators can detect and diagnose problems in the system, such as signal distortion, loss, or noise, and take corrective actions to maintain the performance of the system. +It can be used to compare optical link performance against desired parameters and benchmarks, providing valuable insight into the overall health of the interface link. Below sub-sections will walk through the CLI syntax, output format and high level design. Currently the performance monitoring will be executed only for 400G-ZR modules. + + **Solution:** +Over the defined PM interval time, the statistics are collected for the paramters defined in 7.2 from the transciever, sampled and updated to fixed time window slots of TRANSCEIVER_PM_WINDOW_STATS table for each port in a linecard/box. +The statistics then can be displayed for a specific time window using a CLI. All this functionality will be done by xcvrd process in pmon container. + +#### 7.2 Transceiver PM Window statistics parameters +All the fields from table [2\.1\.5 Transceiver PM Table](#215-transceiver-pm-table) are part of the TRANSCEIVER_PM_WINDOW_STATS table along with below mentioned fields. +``` + ; Defines Transceiver PM Window statistics table information for a port + key = TRANSCEIVER_PM_WINDOW_STATS|ifname ; information of PM on port + ; field = value + window1 = 1*255VCHAR ; PM window number with PM window start time, end time, current and PM_TABLE fields. + window2 = 1*255VCHAR ; PM window number with PM window start time, end time, current and PM_TABLE fields. + . + . + . + window29 = 1*255VCHAR ; PM window number with PM window start time, end time, current and PM_TABLE fields. + +Each window field(Key) in TRANSCEIVER_PM_WINDOW_STATS have a value string comprises of following fields. + + pm_win_start_time = 1*255VCHAR ; PM statistics start time for the window. + pm_win_end_time = 1*255VCHAR ; PM statistics end time for the window. + pm_win_current = 1*255VCHAR ; PM statistics collection is Progressing on this window. (True/False) +``` + +#### 7.3 CLI Sub-options and Syntax + +``` +#show int transceiver ​ +commands:​ +pm show interface transceiver performance monitoring​ +​ +#Show int trans pm ​ +commands:​ +Current show progressing pm data​ +history show historical pm data​ + +​#show int trans pm current