forked from sonic-net/sonic-buildimage
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request sonic-net#154 from stevenlu99/pcs-errors
Port PCS Error counters HLD requirements added
- Loading branch information
Showing
1 changed file
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Feature Name | ||
PCS Error Counters | ||
# High Level Design Document | ||
#### Rev 0.1 | ||
|
||
# Table of Contents | ||
* [List of Tables](#list-of-tables) | ||
* [Revision](#revision) | ||
* [About This Manual](#about-this-manual) | ||
* [Scope](#scope) | ||
* [Definition/Abbreviation](#definitionabbreviation) | ||
|
||
# List of Tables | ||
[Table 1: Abbreviations](#table-1-abbreviations) | ||
|
||
# Revision | ||
| Rev | Date | Author | Change Description | | ||
|:---:|:-----------:|:------------------:|-----------------------------------| | ||
| 0.1 | 04/14/2021 | Steven Lu | Initial version for requirements | | ||
|
||
# About this Manual | ||
This document provides general information about the PCS Error counters feature implementation in SONiC. | ||
# Scope | ||
This document describes the high level design of PCS Error counters feature. Call out any related design that is not covered by this document | ||
|
||
# Definition/Abbreviation | ||
|
||
### Table 1: Abbreviations | ||
| **Term** | **Meaning** | | ||
|--------------------------|-------------------------------------| | ||
| XYZ | Term description | | ||
|
||
# 1 Feature Overview | ||
The PCS Error counters feature collects PCS Errors from Brcm silicons and help customers determine condition of physcial ethernet link | ||
|
||
|
||
|
||
## 1.1 Requirements | ||
PCS Error counters feature should cover Broadcom silicons include Tomahawk-1, Tomahawk-2, Trident-3 and Tomahawk-3 | ||
SONiC shall be able collect PCS Error counters of individual port | ||
SONiC shall be able to display PCS Error counters of individual port | ||
PCS error counters should be collected at same rate as other counters. | ||
Below PCS counters should be collected: | ||
- For 10G/40G/100G NRZ without FEC | ||
Errored Block Count | ||
BER Count | ||
- For PAM4 ports or ports with RS FEC enabled | ||
FEC correctable errors | ||
FEC uncorrectable errors | ||
|
||
### 1.1.1 Functional Requirements | ||
|
||
|
||
### 1.1.3 Scalability Requirements | ||
PCS Error counters feature shall be supported on all physcial ports. All the platform design, SDK, and ASIC constraints should be considered. | ||
|
||
|
||
### 1.1.4 Warm Boot Requirements | ||
Interfaces PCS Error counters must be retained across warmboot. | ||
|
||
|