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

[xcvrd HLD] Update xcvrd HLD doc #586

Merged
merged 15 commits into from
Jun 15, 2021
Merged

[xcvrd HLD] Update xcvrd HLD doc #586

Changes from 2 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
8ec818f
update-xcvrd-hld
keboliu Apr 3, 2020
214e9f7
Update transceiver-monitor-hld.md
keboliu Apr 9, 2020
ea5a58a
describe sfp error in a bitmap way
Junchao-Mellanox Apr 9, 2021
160c7d6
Merge pull request #772 from Junchao-Mellanox/update-xcvrd-hdl
keboliu Apr 9, 2021
a631951
fix table alignment
keboliu Apr 14, 2021
9d5e038
update tile numbering
keboliu Apr 14, 2021
9ce7415
fix broken doc link
keboliu May 6, 2021
79a290f
Update transceiver-monitor-hld.md
keboliu May 6, 2021
ec1e608
fix typo
keboliu May 24, 2021
0e1548b
Adjust the HLD according to the latest discussion with MSFT
stephenxs Jun 1, 2021
08b19c6
Adjust some details
stephenxs Jun 2, 2021
e07f7d6
Merge pull request #791 from stephenxs/update-xcvrd-hdl-error-status
keboliu Jun 2, 2021
09ba0a8
Fix review comments
stephenxs Jun 4, 2021
e99b7d5
Merge pull request #794 from stephenxs/update-xcvrd-hdl-error-status
keboliu Jun 4, 2021
f8893cf
Update doc/xrcvd/transceiver-monitor-hld.md
keboliu Jun 4, 2021
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
17 changes: 15 additions & 2 deletions doc/xrcvd/transceiver-monitor-hld.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ New Transceiver info table and transceiver DOM sensor table will be added to sta
; Defines Transceiver Status info for a port
key = TRANSCEIVER_STATUS|ifname ; Error information for SFP on port
; field = value
status = 1*255VCHAR ; code of the SFP status (plug in, plug out or error)
status = 1*255VCHAR ; code of the SFP status (plug in, plug out)
error = 1*255VCHAR ; SFP error (N/A or a string like error1 | error2 )
jleveque marked this conversation as resolved.
Show resolved Hide resolved


### 1.2 Accessing EEPROM from platform container ###
Expand All @@ -104,7 +105,7 @@ Transceiver EEPROM accessing can be achieved by legacy sfputil.py plugin or new

#### 1.3.1 Transceiver change event ####

Currently 7 transceiver events are defined as below. The first two are for plug in and plug out, others to reflect various error status, vendors can add new error event if they support more.
Currently 7 transceiver events are defined as below.

status='0' SFP removed,
status='1' SFP inserted,
Expand All @@ -114,6 +115,18 @@ Currently 7 transceiver events are defined as below. The first two are for plug
status='5' High Temperature,
status='6' Bad cable.
lguohan marked this conversation as resolved.
Show resolved Hide resolved

However, multiple errors could exists at the same time. For example, a module can be unsupported cable and high temperature. The new transceiver event will be described in a bitmap. New transceiver definition below.
keboliu marked this conversation as resolved.
Show resolved Hide resolved

bit 32 : 0=SFP removed, 1=SFP inserted,
keboliu marked this conversation as resolved.
Show resolved Hide resolved
bit 31 : 0=OK, 1=I2C bus stuck,
bit 30 : 0=OK, 1=Bad eeprom,
bit 29 : 0=OK, 1=Unsupported cable,
bit 28 : 0=OK, 1=High Temperature,
bit 27 : 0=OK, 1=Bad cable.
bit 1~26: reserved. Must be 0.

Vendor can extend this bitmap with more errors. Xcvrd need parse the bitmap and set transceiver status table in DB accordingly. For example, if the transceiver event bit map is 0x7, the status field value should be "1" and the error field value should be "I2C bus stuck | Bad eeprom".

#### 1.3.2 API to get Transceiver change event from platform ####

Xcvrd need to be triggered by transceiver change event to refresh the transceiver info table.
Expand Down