diff --git a/doc/LLR/SAI-Link_Layer_Retry.md b/doc/LLR/SAI-Link_Layer_Retry.md new file mode 100644 index 000000000..61bcceb4e --- /dev/null +++ b/doc/LLR/SAI-Link_Layer_Retry.md @@ -0,0 +1,343 @@ +# SAI Proposal: Link Layer Retry (LLR) + +------------------------------------------------------------------------------- + Title | Link Layer Retry (LLR) +-------------|----------------------------------------------------------------- + Authors | UEC Management WG (Ravindranath C Kanakarajan and Rupa Budhia, Marvell) + Status | In review + Type | Standards track + Created | November 05, 2025 + SAI-Version | 1.18 +------------------------------------------------------------------------------- + + +## Introduction + +Link Layer Retry (LLR) is a hop-by-hop retransmission mechanism designed to mitigate latency caused by end-to-end retransmissions due to link errors (CRC/FEC). It improves performance for latency-sensitive workloads by enabling local retransmission. + +### Overview + +###### Figure 1: LLR Overview + +![LLR Overview](images/llr_overview.svg "Figure 1: LLR Overview") + + +- Frames are assigned sequence numbers in the Ethernet preamble. +- Replay buffers store frames for retransmission. +- Acknowledgements (LLR_ACK) are sent via Control Ordered Sets (CtlOS). +- Negative acknowledgements (LLR_NACK) trigger Go-Back-N retransmissions. + + +### LLR Transmission and Acknowledgement Flow + +- At **LLR Tx**: + - Each frame is assigned a sequence number, which is carried in the frame. + - UEC LLR sends the sequence number in the frame preamble. + - The sequence number is incremented by 1 for each subsequent frame. + - The frame is placed in a **Replay Buffer** for possible retransmission if the link partner does not receive it. + +- At **LLR Rx** (link partner): + - Periodically sends acknowledgements (**LLR_ACKs**) for frames that were successfully received. + - LLR_ACK is **cumulative**, i.e., it carries the sequence number of the most recent successfully received frame. + - UEC LLR sends acknowledgements in **Control Ordered Sets (CtlOS)** inserted into the data stream by the PCS. + - Spacing between CtlOS messages is **configurable**. + +- When an **LLR_ACK** is received back at the sender: + - All frames up to the sequence number in the LLR_ACK are removed from the replay buffer, freeing up space. + - If an ACK is lost, the next received ACK will free up all frames up to the sequence number in that ACK. + +### Error Handling + +- LLR_NACK is sent on receiving a corrupted frame (CRC or uncorrectable FEC errors) or lost (out-of-order) frames. +- Replay timer ensures retransmission if the last frame is lost. +- Replay count prevents indefinite retries. +- Data age timeout limits the amount of time a frame resides in the replay buffer. + + +#### Go-Back-N Scheme + +- **At LLR Rx (Receiver):** + - Detects a missing frame when: + - A frame is received with an out-of-sequence number, or + - A frame is received with a CRC error or an uncorrectable FEC error. + - Sends a **negative acknowledgement (LLR_NACK)** to the sender. + - The **LLR_NACK** includes the sequence number of the most recent successfully received LLR frame. + - Discards all subsequent received frames until a frame with the expected sequence number is received. + - Does **not** send any further ACK or NACK messages during this period. + +- **At LLR Tx (Sender):** + - Upon receiving an **LLR_NACK**: + - Retransmits those frames from the replay buffer whose sequence number is greater than the sequence number in the LLR_NACK. + + +### Replay timer + +- A **replay timer** is maintained at **LLR Tx** to handle cases where: + - The last packet is lost, or + - An **LLR_NACK** is lost, or + - No **LLR_ACKs** or **LLR_NACKs** are received to indicate progress. + +- **Replay is initiated** when the replay timer expires. + +- The replay mechanism: + - Retransmits all frames from the replay buffer. + - Can be performed **multiple times** (capped by `REPLAY_COUNT_MAX`) if no further **LLR_ACKs** are received. + +- The replay timer ensures reliability and prevents indefinite stalling in the absence of acknowledgements. + + +### 'Flush' State in LLR Tx + +The **LLR Tx mechanism** enters a **“FLUSH” state** under any of the following error conditions: + +- The number of **replay attempts exceeds** a configured maximum value (`REPLAY_COUNT_MAX`). +- The **PCS status** remains `FALSE` for longer than the configured timeout (`PCS_LOST_TIMEOUT`). +- **Data remains in the replay buffer** for too long without receiving a successful `LLR_ACK` (`DATA_AGE_TIMEOUT`). + + +In the flush state, depending on configuration, LLR Tx may: + +- **Reinitialize LLR** automatically if `RE_INIT_ON_FLUSH` is set to `true`, OR +- **Wait for management plane intervention** to resolve the issue and manually re-enable LLR. +--- + +## SAI Specification + +###### Figure 2: LLR SAI Objects + +![LLR SAI Objects](images/llr_SAI_objects.svg "Figure 1: LLR SAI Objects") + + +LLR is a new feature in SAI. To support LLR, new attributes and statistics are added to the SAI Port Object. Additionally, a new object called a Port LLR Profile is introduced to model the LLR parameters of a port. + + + + +### Port LLR Profile + +Port LLR Profile contains LLR attributes associated with a port. These attributes are listed in the table below. + +| SAI_PORT_LLR_PROFILE_ATTR | Type | Flags | Default | Description | +|----------|------|-------|---------|-------------| +| OUTSTANDING_FRAMES_MAX | sai_uint32_t | MANDATORY_ON_CREATE, CREATE_ONLY | NA | Max unacknowledged frames | +| OUTSTANDING_BYTES_MAX | sai_uint32_t | MANDATORY_ON_CREATE, CREATE_ONLY | NA | Max unacknowledged bytes | +| REPLAY_TIMER_MAX | sai_uint32_t | CREATE_AND_SET | 0 | Replay timer threshold | +| REPLAY_COUNT_MAX | sai_uint8_t | CREATE_AND_SET | 1 | Max replay attempts | +| PCS_LOST_TIMEOUT | sai_uint32_t | CREATE_AND_SET | 0 | Timeout for PCS loss | +| DATA_AGE_TIMEOUT | sai_uint32_t | CREATE_AND_SET | 0 | Max age of replay buffer data | +| INIT_LLR_FRAME_ACTION | sai_llr_frame_action_t | CREATE_AND_SET | BEST_EFFORT | Action in INIT state | +| FLUSH_LLR_FRAME_ACTION | sai_llr_frame_action_t | CREATE_AND_SET | BEST_EFFORT | Action in FLUSH state | +| RE_INIT_ON_FLUSH | bool | CREATE_AND_SET | false | Auto re-init after flush | +| CTLOS_TARGET_SPACING | sai_uint16_t | CREATE_AND_SET | 2048 | CtlOS spacing in bytes | + +#### Frame Action Types + +| sai_llr_ frame_action_t | Description | +|------|-------------| +| SAI_LLR_FRAME_ACTION_DISCARD | Drop frames | +| SAI_LLR_FRAME_ACTION_BLOCK | Block transmission | +| SAI_LLR_FRAME_ACTION_BEST_EFFORT | Treat as regular packets | + +### SAI Port Updates + +New attributes are added to the existing SAI Port object to attach a LLR Profile to the Port, enable LLR, and read LLR status. + +| SAI_PORT _ATTR| Type | Flags | Default | Description | +|----------|------|-------|---------|-------------| +| LLR_MODE_LOCAL | bool | CREATE_AND_SET | false | Enable local INIT reception | +| LLR_MODE_REMOTE | bool | CREATE_AND_SET | false | Enable remote INIT transmission | +| LLR_PROFILE | object ID | CREATE_AND_SET | NULL | Associated LLR profile | +| LLR_TX_STATUS | sai_port_llr_tx_status_t | READ_ONLY | NA | TX state | +| LLR_RX_STATUS | sai_port_llr_rx_status_t | READ_ONLY | NA | RX state | + +#### Port LLR Tx Status + +| sai_port_llr_tx_status_t | Description | +|------|-------------| +| SAI_PORT_LLR_TX_STATUS_OFF | TX disabled | +| SAI_PORT_LLR_TX_STATUS_INIT | Sending INIT messages | +| SAI_PORT_LLR_TX_STATUS_ADVANCE | Normal operation | +| SAI_PORT_LLR_TX_STATUS_REPLAY | Replay in progress | +| SAI_PORT_LLR_TX_STATUS_FLUSH | Flush state | + +#### Port LLR Rx Status + +| sai_port_llr_rx_status_t | Description | +|------|-------------| +| SAI_PORT_LLR_RX_STATUS_OFF | RX disabled | +| SAI_PORT_LLR_RX_STATUS_SEND_ACKS | Normal ACK operation | +| SAI_PORT_LLR_RX_STATUS_SEND_NACK | Sending NACK | +| SAI_PORT_LLR_RX_STATUS_NACK_SENT | Awaiting expected frame | + +#### Port Error Status + + +The `sai_port_error_status_t` is an existing enum used by the SAI implementation to convey the **operational status** of a port when a state change is detected. Each enum value represents a **bit flag**, allowing multiple fault conditions to be encoded simultaneously. A new enum value is introduced to indicate that the port Tx mechanism's flush state. + + +| sai_port_error_status_t | Description | +|------|-------------| +| SAI_PORT_ERROR_STATUS_LLR_TX_FLUSH | TX entered/exited flush state | + +### Port LLR Statistics + +Includes counters for: + +- INIT/INIT_ECHO/ACK/NACK CtlOS TX/RX +- Frame discards, poisoned frames, replays +- Sequence errors, missing/duplicate sequences + +| **SAI_PORT_STAT** | **Description** | +|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LLR_TX_INIT_CTL_OS | Number of LLR_INIT control ordered sets transmitted | +| LLR_TX_INIT_ECHO_CTL_OS | Number of LLR_INIT_ECHO control ordered sets transmitted | +| LLR_TX_ACK_CTL_OS | Number of LLR_ACK control ordered sets transmitted | +| LLR_TX_NACK_CTL_OS | Number of LLR_NACK control ordered sets transmitted | +| LLR_TX_DISCARD | Number of LLR-eligible frames discarded by the LLR TX when:
• the TX state machine is in the INIT state, and `llr_init_behavior` is set to DISCARD
• the TX state machine is in the FLUSH state, and `llr_flush_behavior` is set to DISCARD | +| LLR_TX_OK | Number of LLR-eligible frames transmitted with a good FCS | +| LLR_TX_POISONED | Number of LLR-eligible frames transmitted with a poisoned FCS | +| LLLR_TX_REPLAY | Number of times that LLR Tx completed a replay operation | +| LLR_RX_INIT_CTL_OS | Number of LLR_INIT control ordered sets received | +| LLR_RX_INIT_ECHO_CTL_OS | Number of LLR_INIT_ECHO control ordered sets received | +| LLR_RX_ACK_CTL_OS | Number of LLR_ACK control ordered sets received | +| LLR_RX_NACK_CTL_OS | Number of LLR_NACK control ordered sets received | +| LLR_RX_ACK_NACK_SEQ_ERROR | Number of LLR_ACK/LLR_NACK sequence number errors. Incremented when an ACK/NACK is received with an unexpected sequence number | +| LLR_RX_OK | Number of LLR-eligible frames received with a good FCS | +| LLR_RX_POISONED | Number of LLR-eligible frames received with a poisoned FCS | +| LLR_RX_BAD | Number of LLR-eligible frames received with a bad FCS | +| LLR_RX_EXPECTED_SEQ_GOOD | Number of LLR-eligible frames received with a good FCS and the expected sequence number | +| LLR_RX_EXPECTED_SEQ_POISONED | Number of LLR-eligible frames received with a poisoned FCS and the expected sequence number | +| LLR_RX_EXPECTED_SEQ_BAD | Number of LLR-eligible frames received with a bad FCS and the expected sequence number | +| LLR_RX_MISSING_SEQ | Number of LLR-eligible frames received with a sequence number indicating a missing frame in the sequence, regardless of FCS status | +| LLR_RX_DUPLICATE_SEQ | Number of LLR-eligible frames received with a duplicate sequence number, regardless of FCS status | +| LLR_RX_REPLAY | Number of times that LLR Rx detected the start of a replay | + +--- + +## Workflow + + +### 1) Create LLR Profile + +```c +sai_attr_list[0].id = SAI_PORT_LLR_PROFILE_ATTR_OUTSTANDING_FRAMES_MAX; +sai_attr_list[0].value.u32 = 100; + +sai_attr_list[1].id = SAI_PORT_LLR_PROFILE_ATTR_OUTSTANDING_BYTES_MAX; +sai_attr_list[1].value.u32 = 102400; + +sai_attr_list[2].id = SAI_PORT_LLR_PROFILE_ATTR_REPLAY_TIMER_MAX; +sai_attr_list[2].value.u32 = 10000; + +sai_attr_list[3].id = SAI_PORT_LLR_PROFILE_ATTR_REPLAY_COUNT_MAX; +sai_attr_list[3].value.u32 = 255; + +sai_attr_list[4].id = SAI_PORT_LLR_PROFILE_ATTR_PCS_LOST_TIMEOUT; +sai_attr_list[4].value.u32 = 500; + +sai_attr_list[5].id = SAI_PORT_LLR_PROFILE_ATTR_DATA_AGE_TIMEOUT; +sai_attr_list[5].value.u32 = 100000; + +attr_count = 6; +sai_create_llr_profile_fn(&sai_llr_profile_id, switch_id, attr_count, sai_attr_list); +``` + + +### 2) Enable LLR on a port + +```c +sai_attr_list[0].id = SAI_PORT_ATTR_LLR_PROFILE; +sai_attr_list[0].value.oid = sai_llr_profile_id; +sai_set_port_attribute_fn(sai_port_id, switch_id, 1, sai_attr_list); + +sai_attr_list[0].id = SAI_PORT_ATTR_LLR_MODE_LOCAL; +sai_attr_list[0].value.booldata = true; +sai_set_port_attribute_fn(sai_port_id, switch_id, 1, sai_attr_list); + +sai_attr_list[0].id = SAI_PORT_ATTR_LLR_MODE_REMOTE; +sai_attr_list[0].value.booldata = true; +sai_set_port_attribute_fn(sai_port_id, switch_id, 1, sai_attr_list); +``` + +### 3) Get LLR Port Status + +```c + +sai_attr_list[0].id = SAI_PORT_ATTR_LLR_RX_STATUS; +sai_attr_list[1].id = SAI_PORT_ATTR_LLR_TX_STATUS; +sai_get_port_attribute_fn(sai_port_id, switch_id, 2, sai_attr_list); + +``` +### 4) Get LLR Port Statistics + + +```c +sai_stat_capability_list_t sai_port_stats_capability; +sai_port_stats_capability.count = SAI_PORT_STAT_END; + +sai_stat_capability_t stats[SAI_PORT_STAT_END] = {}; +sai_port_stats_capability.list = stats; + +sai_query_stats_capability(switch_id, SAI_OBJECT_TYPE_PORT, sai_port_stats_capability); + +sai_port_stat_t supported_stat_ids[SAI_PORT_STAT_END] = {0}; +int j = 0; + +for (int i = 0; i < sai_port_stats_capability.count; i++) { + switch (sai_port_stats_capability.list[i].stat_enum) { + case SAI_PORT_STAT_LLR_TX_INIT_CTL_OS: + case SAI_PORT_STAT_LLR_TX_INIT_ECHO_CTL_OS: + case SAI_PORT_STAT_LLR_RX_REPLAY: + if (sai_port_stats_capability.list[i].stat_modes & SAI_STAT_MODE_READ) { + supported_stat_ids[j++] = sai_port_stats_capability.list[i].stat_enum; + } + break; + default: + break; + } +} + +sai_get_port_stats_fn(sai_port_id, switch_id, j, supported_stat_ids, counters); +``` + +## Capability Queries + +### Feature Capability + +Use existing `sai_query_attribute_capability()` to check support for: + +- `SAI_PORT_ATTR_LLR_PROFILE` +- `SAI_PORT_ATTR_LLR_MODE_LOCAL` +- `SAI_PORT_ATTR_LLR_MODE_REMOTE` +- etc. + +Example: +```c +sai_query_attribute_capability( + switch_id, + SAI_OBJECT_TYPE_PORT, + SAI_PORT_ATTR_LLR_PROFILE, + attr_cap); +``` + +### Statistics Capability + +Use existing `sai_query_stats_capability()` to check support for any of the new LLR port stats `SAI_PORT_STAT_LLR_xxx`. + +Example: +```c +sai_stat_capability_list_t sai_port_stats_capability; +stats_capability.count = SAI_PORT_STAT_END; +stats_capability.list = stats.data(); +sai_query_stats_capability( + switch_id, + SAI_OBJECT_TYPE_PORT, + &sai_port_stats_capability); +``` +--- + +## Normative References + +- [UE Specification 1.0 Chapter 5.1](https://ultraethernet.org/wp-content/uploads/sites/20/2025/06/UE-Specification-6.11.25.pdf) + +--- diff --git a/doc/LLR/images/llr_SAI_objects.svg b/doc/LLR/images/llr_SAI_objects.svg new file mode 100644 index 000000000..37d35a81f --- /dev/null +++ b/doc/LLR/images/llr_SAI_objects.svg @@ -0,0 +1 @@ +Port LLR Profile 1Object Overview of SAI Attributes for LLRSwitch ObjectPort 1 ObjectPort 2 ObjectPort n Object•New SAI Object•Models LLR configuration params•Existing Port Object is enhanced to:•Enable/disable LLR•Attach an LLR Profile Object•Get LLR Status•Port StatisticsPort LLR Profile 2Object \ No newline at end of file diff --git a/doc/LLR/images/llr_overview.svg b/doc/LLR/images/llr_overview.svg new file mode 100644 index 000000000..6995887fd --- /dev/null +++ b/doc/LLR/images/llr_overview.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/inc/saiport.h b/inc/saiport.h index d0f5b380e..4871d8bb1 100644 --- a/inc/saiport.h +++ b/inc/saiport.h @@ -123,7 +123,10 @@ typedef enum _sai_port_error_status_t SAI_PORT_ERROR_STATUS_SIGNAL_LOCAL_ERROR = 1 << 11, /** Port is not accepting reachability data units */ - SAI_PORT_ERROR_STATUS_NO_RX_REACHABILITY = 1 << 12 + SAI_PORT_ERROR_STATUS_NO_RX_REACHABILITY = 1 << 12, + + /** Port LLR Tx mechanism entering or exiting flush state */ + SAI_PORT_ERROR_STATUS_LLR_TX_FLUSH = 1 << 13 } sai_port_error_status_t; /** @@ -709,6 +712,72 @@ typedef enum _sai_port_serdes_polarity_t } sai_port_serdes_polarity_t; +/** + * @brief LLR Tx status value + */ +typedef enum _sai_port_llr_tx_status_t +{ + /** LLR_TX_ENABLE is false */ + SAI_PORT_LLR_TX_STATUS_OFF, + + /** + * @brief LLR Tx is enabled and sending periodic INIT messages. + * Waiting for INIT_ECHO to be received from link partner + */ + SAI_PORT_LLR_TX_STATUS_INIT, + + /** LLR Tx in normal operation, and no replay is in progress */ + SAI_PORT_LLR_TX_STATUS_ADVANCE, + + /** LLR Tx Replay is in progress */ + SAI_PORT_LLR_TX_STATUS_REPLAY, + + /** LLR mechanism is in flush state */ + SAI_PORT_LLR_TX_STATUS_FLUSH + +} sai_port_llr_tx_status_t; + +/** + * @brief LLR Rx status value + */ +typedef enum _sai_port_llr_rx_status_t +{ + /** LLR_RX_ENABLE is false */ + SAI_PORT_LLR_RX_STATUS_OFF, + + /** + * @brief LLR receive is in normal operation and sending ACK. + * No missing/bad frames have been received + */ + SAI_PORT_LLR_RX_STATUS_SEND_ACKS, + + /** + * @brief LLR detected a missing frame or received a bad frame, + * and is in the process of sending the NACK + */ + SAI_PORT_LLR_RX_STATUS_SEND_NACK, + + /** LLR sent a NACK and is waiting for the expected frame */ + SAI_PORT_LLR_RX_STATUS_NACK_SENT + +} sai_port_llr_rx_status_t; + +/** + * @brief LLR frame action + */ +typedef enum _sai_llr_frame_action_t +{ + /** Frames are dropped. */ + SAI_LLR_FRAME_ACTION_DISCARD, + + /** Blocks transmission requests from higher layers to the MAC. */ + SAI_LLR_FRAME_ACTION_BLOCK, + + /** Frames are treated as regular packets and are transmitted. */ + SAI_LLR_FRAME_ACTION_BEST_EFFORT, + +} sai_llr_frame_action_t; + /** * @brief Attribute Id in sai_set_port_attribute() and * sai_get_port_attribute() calls @@ -2731,6 +2800,7 @@ typedef enum _sai_port_attr_t */ SAI_PORT_ATTR_SERDES_FW_REVISION, + /** * @brief Per Lane PRBS Lock Status * @@ -2786,6 +2856,52 @@ typedef enum _sai_port_attr_t */ SAI_PORT_ATTR_PRBS_PER_LANE_BER_LIST, + /** + * @brief Enable the port to start receiving LLR INIT messages. + * + * @type bool + * @flags CREATE_AND_SET + * @default false + */ + SAI_PORT_ATTR_LLR_MODE_LOCAL, + + /** + * @brief Enable the port to start sending LLR INIT messages. + * + * @type bool + * @flags CREATE_AND_SET + * @default false + */ + SAI_PORT_ATTR_LLR_MODE_REMOTE, + + /** + * @brief The LLR profile to configure the port's LLR mechanism. + * Mandatory when LLR_MODE_LOCAL and/or LLR_MODE_REMOTE are true. + * + * @type sai_object_id_t + * @flags CREATE_AND_SET + * @objects SAI_OBJECT_TYPE_PORT_LLR_PROFILE + * @allownull true + * @default SAI_NULL_OBJECT_ID + */ + SAI_PORT_ATTR_LLR_PROFILE, + + /** + * @brief Port LLR TX status + * + * @type sai_port_llr_tx_status_t + * @flags READ_ONLY + */ + SAI_PORT_ATTR_LLR_TX_STATUS, + + /** + * @brief Port LLR RX status + * + * @type sai_port_llr_rx_status_t + * @flags READ_ONLY + */ + SAI_PORT_ATTR_LLR_RX_STATUS, + /** * @brief End of attributes */ @@ -3473,6 +3589,76 @@ typedef enum _sai_port_stat_t /** Packets trimmed and successfully transmitted on port */ SAI_PORT_STAT_TX_TRIM_PACKETS, + /** Number of LLR_INIT control ordered sets transmitted */ + SAI_PORT_STAT_LLR_TX_INIT_CTL_OS, + + /** Number of LLR_INIT_ECHO control ordered sets transmitted */ + SAI_PORT_STAT_LLR_TX_INIT_ECHO_CTL_OS, + + /** Number of LLR_ACK control ordered sets transmitted */ + SAI_PORT_STAT_LLR_TX_ACK_CTL_OS, + + /** Number of LLR_NACK control ordered sets transmitted */ + SAI_PORT_STAT_LLR_TX_NACK_CTL_OS, + + /** + * @brief Number of LLR-eligible frames discarded by the LLR TX when + * the TX state machine is in the INIT state and the llr_init_behavior is set to DISCARD, or + * the TX state machine is in the FLUSH state and the llr_flush_behavior is set to DISCARD + */ + SAI_PORT_STAT_LLR_TX_DISCARD, + + /** Number of LLR-eligible frames transmitted with a good FCS */ + SAI_PORT_STAT_LLR_TX_OK, + + /** Number of LLR-eligible frames transmitted with a poisoned FCS */ + SAI_PORT_STAT_LLR_TX_POISONED, + + /** Number of times that LLR Tx completed a replay operation */ + SAI_PORT_STAT_LLR_TX_REPLAY, + + /** Number of LLR_INIT control ordered sets received */ + SAI_PORT_STAT_LLR_RX_INIT_CTL_OS, + + /** Number of LLR_INIT_ECHO control ordered sets received */ + SAI_PORT_STAT_LLR_RX_INIT_ECHO_CTL_OS, + + /** Number of LLR_ACK control ordered sets received */ + SAI_PORT_STAT_LLR_RX_ACK_CTL_OS, + + /** Number of LLR_NACK control ordered sets received */ + SAI_PORT_STAT_LLR_RX_NACK_CTL_OS, + + /** Number of LLR_ACK/LLR_NACK sequence number errors. The counter is incremented each time an LLR_ACK or LLR_NACK is received with an unexpected sequence number */ + SAI_PORT_STAT_LLR_RX_ACK_NACK_SEQ_ERROR, + + /** Number of LLR-eligible frames received with a good FCS */ + SAI_PORT_STAT_LLR_RX_OK, + + /** Number of LLR-eligible frames received with a poisoned FCS */ + SAI_PORT_STAT_LLR_RX_POISONED, + + /** Number of LLR-eligible frames received with a bad FCS */ + SAI_PORT_STAT_LLR_RX_BAD, + + /** Number of LLR-eligible frames received with a good FCS and with the expected sequence number */ + SAI_PORT_STAT_LLR_RX_EXPECTED_SEQ_GOOD, + + /** Number of LLR-eligible frames received with a poisoned FCS and with the expected sequence number */ + SAI_PORT_STAT_LLR_RX_EXPECTED_SEQ_POISONED, + + /** Number of LLR-eligible frames received with a bad FCS and with the expected sequence number */ + SAI_PORT_STAT_LLR_RX_EXPECTED_SEQ_BAD, + + /** Number of LLR-eligible frames received with a sequence number that indicated a missing LLR-eligible frame in the sequence, irrespective of FCS status */ + SAI_PORT_STAT_LLR_RX_MISSING_SEQ, + + /** Number of LLR-eligible frames received with a duplicate sequence number, irrespective of FCS status */ + SAI_PORT_STAT_LLR_RX_DUPLICATE_SEQ, + + /** Number of times that LLR Rx detected the start of a replay */ + SAI_PORT_STAT_LLR_RX_REPLAY, + /** Port stat in drop reasons range start */ SAI_PORT_STAT_IN_DROP_REASON_RANGE_BASE = 0x00001000, @@ -4665,6 +4851,175 @@ typedef sai_status_t (*sai_get_port_connector_attribute_fn)( _In_ uint32_t attr_count, _Inout_ sai_attribute_t *attr_list); +/** + * @brief List of Port LLR profile attributes + */ +typedef enum _sai_port_llr_profile_attr_t +{ + /** + * @brief Start of attributes + */ + SAI_PORT_LLR_PROFILE_ATTR_START, + + /** + * @brief Limit on the number of unacknowledged frames. + * + * @type sai_uint32_t + * @flags MANDATORY_ON_CREATE|CREATE_ONLY + */ + SAI_PORT_LLR_PROFILE_ATTR_OUTSTANDING_FRAMES_MAX = SAI_PORT_LLR_PROFILE_ATTR_START, + + /** + * @brief Limit on the number of unacknowledged bytes. + * + * @type sai_uint32_t + * @flags MANDATORY_ON_CREATE|CREATE_ONLY + */ + SAI_PORT_LLR_PROFILE_ATTR_OUTSTANDING_BYTES_MAX, + + /** + * @brief A configuration parameter that sets the maximum timer value in nanoseconds. + * When this timer expires, a replay is initiated. + * + * @type sai_uint32_t + * @flags CREATE_AND_SET + * @default 0 + */ + SAI_PORT_LLR_PROFILE_ATTR_REPLAY_TIMER_MAX, + + /** + * @brief Limit on the number of replays if no further LLR_ACKs are received. + * Once the limit is reached, LLR enters a 'FLUSH' state. + * A value of 255 indicates that there is no maximum. + * + * @type sai_uint8_t + * @flags CREATE_AND_SET + * @default 1 + */ + SAI_PORT_LLR_PROFILE_ATTR_REPLAY_COUNT_MAX, + + /** + * @brief If the port PCS status is false for this duration, LLR enters a 'FLUSH' state. + * The value is specified in nanoseconds. + * + * @type sai_uint32_t + * @flags CREATE_AND_SET + * @default 0 + */ + SAI_PORT_LLR_PROFILE_ATTR_PCS_LOST_TIMEOUT, + + /** + * @brief Limit of the time a frame can reside in the replay buffer. + * The value is specified in nanoseconds. + * + * @type sai_uint32_t + * @flags CREATE_AND_SET + * @default 0 + */ + SAI_PORT_LLR_PROFILE_ATTR_DATA_AGE_TIMEOUT, + + /** + * @brief The action to be taken on frames received from the higher layers when the LLR mechanism enters the 'INIT' state. + * + * @type sai_llr_frame_action_t + * @flags CREATE_AND_SET + * @default SAI_LLR_FRAME_ACTION_BEST_EFFORT + */ + SAI_PORT_LLR_PROFILE_ATTR_INIT_LLR_FRAME_ACTION, + + /** + * @brief The action to be taken on frames received from the higher layers when the LLR mechanism enters the 'FLUSH' state. + * + * @type sai_llr_frame_action_t + * @flags CREATE_AND_SET + * @default SAI_LLR_FRAME_ACTION_BEST_EFFORT + */ + SAI_PORT_LLR_PROFILE_ATTR_FLUSH_LLR_FRAME_ACTION, + + /** + * @brief Indicates that the LLR mechanism must reinitialize LLR when it enters the 'FLUSH' State. + * + * @type bool + * @flags CREATE_AND_SET + * @default false + */ + SAI_PORT_LLR_PROFILE_ATTR_RE_INIT_ON_FLUSH, + + /** + * @brief Desired spacing between CtlOS messages in bytes between transmission of successive LLR_ACK / LLR_NACK CtlOS. + * + * @type sai_uint16_t + * @flags CREATE_AND_SET + * @isvlan false + * @default 2048 + */ + SAI_PORT_LLR_PROFILE_ATTR_CTLOS_TARGET_SPACING, + + /** + * @brief End of attributes + */ + SAI_PORT_LLR_PROFILE_ATTR_END, + + /** Custom range base value */ + SAI_PORT_LLR_PROFILE_ATTR_CUSTOM_RANGE_START = 0x10000000, + + /** End of custom range base */ + SAI_PORT_LLR_PROFILE_ATTR_CUSTOM_RANGE_END + +} sai_port_llr_profile_attr_t; + +/** + * @brief Create Port LLR Profile + * + * @param[out] port_llr_profile_id Port LLR Profile id + * @param[in] switch_id Switch id + * @param[in] attr_count Number of attributes + * @param[in] attr_list Array of attributes + * + * @return #SAI_STATUS_SUCCESS on success, failure status code on error + */ +typedef sai_status_t (*sai_create_port_llr_profile_fn)( + _Out_ sai_object_id_t *port_llr_profile_id, + _In_ sai_object_id_t switch_id, + _In_ uint32_t attr_count, + _In_ const sai_attribute_t *attr_list); + +/** + * @brief Remove Port LLR Profile + * + * @param[in] port_llr_profile_id Port LLR Profile id + * + * @return #SAI_STATUS_SUCCESS on success, failure status code on error + */ +typedef sai_status_t (*sai_remove_port_llr_profile_fn)( + _In_ sai_object_id_t port_llr_profile_id); + +/** + * @brief Set Port LLR Profile attribute value. + * + * @param[in] port_llr_profile_id Port LLR Profile id + * @param[in] attr Attribute + * + * @return #SAI_STATUS_SUCCESS on success, failure status code on error + */ +typedef sai_status_t (*sai_set_port_llr_profile_attribute_fn)( + _In_ sai_object_id_t port_llr_profile_id, + _In_ const sai_attribute_t *attr); + +/** + * @brief Get Port LLR Profile attribute value. + * + * @param[in] port_llr_profile_id Port LLR Profile id + * @param[in] attr_count Number of attributes + * @param[inout] attr_list Array of attributes + * + * @return #SAI_STATUS_SUCCESS on success, failure status code on error + */ +typedef sai_status_t (*sai_get_port_llr_profile_attribute_fn)( + _In_ sai_object_id_t port_llr_profile_id, + _In_ uint32_t attr_count, + _Inout_ sai_attribute_t *attr_list); + /** * @brief Port methods table retrieved with sai_api_query() */ @@ -4701,6 +5056,10 @@ typedef struct _sai_port_api_t sai_bulk_object_remove_fn remove_port_serdess; sai_bulk_object_set_attribute_fn set_port_serdess_attribute; sai_bulk_object_get_attribute_fn get_port_serdess_attribute; + sai_create_port_llr_profile_fn create_port_llr_profile; + sai_remove_port_llr_profile_fn remove_port_llr_profile; + sai_set_port_llr_profile_attribute_fn set_port_llr_profile_attribute; + sai_get_port_llr_profile_attribute_fn get_port_llr_profile_attribute; } sai_port_api_t; /** diff --git a/inc/saitypes.h b/inc/saitypes.h index e38308c2a..1f7700357 100644 --- a/inc/saitypes.h +++ b/inc/saitypes.h @@ -302,6 +302,7 @@ typedef enum _sai_object_type_t SAI_OBJECT_TYPE_PREFIX_COMPRESSION_TABLE = 112, SAI_OBJECT_TYPE_PREFIX_COMPRESSION_ENTRY = 113, SAI_OBJECT_TYPE_SYNCE_CLOCK = 114, + SAI_OBJECT_TYPE_PORT_LLR_PROFILE = 115, /** Must remain in last position */ SAI_OBJECT_TYPE_MAX, diff --git a/meta/acronyms.txt b/meta/acronyms.txt index c960e4ced..3c6dd20f0 100644 --- a/meta/acronyms.txt +++ b/meta/acronyms.txt @@ -1,4 +1,5 @@ # this file defines acronyms, one acronym per line +ACK - Acknowledgement ACL - Access Control List AES - Advanced Encryption Standard AN - Association Number @@ -91,6 +92,7 @@ L2MC - Layer 2 Multi Cast L3 - Layer 3 LAG - Link Aggregation Group LDP - Label Distribution Protocol +LLR - Link Layer Retry LPM - Longest Prefix Match LSP - Label Switched Path MAC - Medium Access Control @@ -100,6 +102,7 @@ MILLI - milli (1/1000) MMU - Memory Management Unit MPLS - Multi Protocol Label Switching MTU - Maximum Transmission Unit +NACK - Negative Acknowledgement NAPT - Network Address Port Translation NHLFE - Next Hop Label Forwarding Entry NMOS - N-channel Metal Oxide Semiconductor diff --git a/meta/aspell.en.pws b/meta/aspell.en.pws index c74c935a9..69451dd13 100644 --- a/meta/aspell.en.pws +++ b/meta/aspell.en.pws @@ -29,6 +29,7 @@ const couldn cpp cpu +CtlOS decap decapsulation Decrement @@ -77,6 +78,7 @@ idriver ifdef INET ingressing +INIT inout InPktsDelayed InPktsLate