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

Update sff_mgr HLD to include high power class enabling and lpmode off #1867

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update sff_mgr HLD to include high power class enabling and lpmode off #1867

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6429c3f
Update sff_mgr to include high power class enabling and lpmode toggle
longhuan-cisco Dec 12, 2024
8abfb03
Add sff-8636 ref
longhuan-cisco Dec 12, 2024
f98bbb7
Fix typo
longhuan-cisco Dec 13, 2024
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
37 changes: 15 additions & 22 deletions doc/xrcvd/Interface-Link-bring-up-sequence-on-sff-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ According to parent [HLD](https://github.com/sonic-net/SONiC/blob/master/doc/sfp
According to parent [HLD](https://github.com/sonic-net/SONiC/blob/master/doc/sfp-cmis/Interface-Link-bring-up-sequence.md#objective), have a determistic approach for Interface link bring-up sequence for SFF compliant modules (100G/40G) i.e. below sequence to be followed:
1. Initialize and enable NPU Tx and Rx path
2. For system with 'External' PHY: Initialize and enable PHY Tx and Rx on both line and host sides; ensure host side link is up
3. Then perform optics Tx enable
3. Enable high power class if module's power class is greater or equal to 5 (Refer to SFF-8636 spec `6.2.6 Control Functions (Page 00h, Bytes 86-99)` for byte 93 definition)
4. Turn off lpmode
5. Then perform optics Tx enable

# Plan

Expand All @@ -86,16 +88,16 @@ Refer to parent [HLD](https://github.com/sonic-net/SONiC/blob/master/doc/sfp-cmi

# Feature enablement

This feature (optics Interface Link bring-up sequence) would be enabled on per platform basis.
Optics Interface Link bring-up sequence would be enabled on per platform basis.
There could be cases where vendor(s)/platform(s) may take time to shift from existing codebase to the model (work-flows) described in this document.
- By default, sff_mgr feature is disabled.
- In order to enable sff_mgr feature, the platform would set ‘enable_xcvrd_sff_mgr’ to ‘true’ in their respective pmon_daemon_control.json. Xcvrd would parse ‘enable_xcvrd_sff_mgr’ and if found 'true', it would launch SFF task manager (sff_mgr).
- sff_mgr thread is always spawned, handling lpmode and high power class setting. But by default, sff_mgr doesn't controll module Tx.
- In order to enable sff_mgr's controlling for module Tx, the platform would set ‘enable_xcvrd_sff_mgr_controlled_tx’ to ‘true’ in their respective pmon_daemon_control.json. Xcvrd would parse ‘enable_xcvrd_sff_mgr_controlled_tx’ and if found 'true', it would launch SFF task manager (sff_mgr).

# Pre-requisite

In addition to parent HLD's [pre-requisite](https://github.com/sonic-net/SONiC/blob/master/doc/sfp-cmis/Interface-Link-bring-up-sequence.md#pre-requisite),

> **_Pre-requisite for enabling sff_mgr:_**
> **_Pre-requisite for enabling sff_mgr_controlled_tx:_**
Platform needs to leave the transceiver (if capable of disabling Tx) in Tx disabled state when an module inserted or during boot-up. This is to make sure the transceiver is not transmitting with Tx enabled before host_tx_ready is True.

# Proposed Work-Flows
Expand All @@ -114,21 +116,6 @@ Platform needs to leave the transceiver (if capable of disabling Tx) in Tx disab
C --> D
D --> End
```
- ### Feature enablment flow -- how xcvrd spawns sff_mgr thread based on enable_sff_mgr flag
```mermaid
graph TD;
A[wait for PortConfigDone]
B[check if enable_sff_mgr flag exists and is set to true]
C[spawn sff_mgr]
D[proceed to other thread spawning and tasks]

Start --> A
A --> B
B -- true --> C
C --> D
B -- false --> D
D --> End
```
- ### Flow of calculating target tx_disable value:
- When ```tx_disable value/status``` is ```True```, it means Tx is disabed
- when ```tx_disable value/status``` is ```False```, it means Tx is enabled
Expand Down Expand Up @@ -160,6 +147,10 @@ Platform needs to leave the transceiver (if capable of disabling Tx) in Tx disab
F[calculate target tx_disable value based on host_tx_ready and admin_status]
G[check if tx_disable status on module is already the target value]
H[go ahead to enable/disable Tx based on the target tx_disable value]
I[enable high power class if module's power class is greater or equal to 5]
J[toggle off lpmode]
K[check if it's insertion event]
L[check if flag sff_mgr_controlled_tx is True]

Start --> A
A --> B
Expand All @@ -168,9 +159,11 @@ Platform needs to leave the transceiver (if capable of disabling Tx) in Tx disab
C -- if neither event happened --> B
E --> E2
E2 --> D
D -- true --> F
D -- true --> K -- true --> I --> J --> L
D -- false --> B
F --> G
K -- false --> L
L -- true --> F --> G
L -- false --> B
G -- true --> B
G -- false --> H
H --> B
Expand Down