UEC CSIG Protocol

Signed-off-by: JaiOCP <jai.kumar@broadcom.com>

Author: JaiOCP

doc/CSIG/SAI-CSIG-Spec.md

@@ -147,81 +147,47 @@ The sai_tam_int_type_t enum specifies types of INT technologies supported by the
 
 
 ### 4.4 TAM INT BW Interval
-The time interval is configured for both the available bandwidth and normalized available bandwidth computations. To support this, new enum has been defined for the configurable time interval values. Additionally, a vendor defined enum has been added to ensure support for vendor-specific time iterval implementations.
+The time interval is configured for both available bandwidth and normalized available bandwidth computations. Two related attributes have been introduced: switch-level attributes to query the number of timers and the specific time interval values.
 
-```
-/**
- * @brief Bandwidth time interval units
- */
-typedef enum _sai_tam_int_bw_time_interval_unit_t
-{
-    /**
-     * @brief Time interval unit nanosecond
-     */
-    SAI_TAM_INT_BW_TIME_INTERVAL_UNIT_NANOSEC,
-
-    /**
-     * @brief Time interval unit microsecond
-     */
-    SAI_TAM_INT_BW_TIME_INTERVAL_UNIT_USEC,
-
-    /**
-     * @brief Time interval unit millisecond
-     */
-    SAI_TAM_INT_BW_TIME_INTERVAL_UNIT_MSEC,
-
-} sai_tam_int_bw_time_interval_unit_t;
+The NOS must first query the supported number of timer intervals and the interval values before programming the timer interval for compact and/or wide tags for ABW and/or ABW/C signals.
 
-/**
- * @brief BW time intervals
- */
-typedef enum _sai_tam_int_bw_time_interval_t
-{
-    /**
-     * @brief Time window 128
-     */
-    SAI_TAM_INT_BW_TIME_INTERVAL_128,
-
-    /**
-     * @brief Time window 256
-     */
-    SAI_TAM_INT_BW_TIME_INTERVAL_256,
-
-    /**
-     * @brief Time window 384
-     */
-    SAI_TAM_INT_BW_TIME_INTERVAL_384,
+#### 4.4.1 Switch Level Timer Attributes
+Switch level attributes are READ ONLY attributes to learn about implementation's capability.
 
+```
     /**
-     * @brief Time window 512
+     * @brief Maximum number of timers supported for CSIG bandwidth signal
+     *
+     * @type sai_uint8_t
+     * @flags READ_ONLY
      */
-    SAI_TAM_INT_BW_TIME_INTERVAL_512,
+    SAI_SWITCH_ATTR_MAX_CSIG_TIMERS,
 
     /**
-     * @brief Time window 640
+     * @brief CSIG Bandwidth time intervals supported in microseconds valid only for available and relative available bandwidth signal type
+     *
+     * @type sai_u32_list_t
+     * @flags READ_ONLY
      */
-    SAI_TAM_INT_BW_TIME_INTERVAL_640,
+    SAI_SWITCH_ATTR_CSIG_BW_TIME_INTERVAL_IN_USEC,
 
-    /**
-     * @brief Time window 768
-     */
-    SAI_TAM_INT_BW_TIME_INTERVAL_768,
+```
 
-    /**
-     * @brief Time window 896
-     */
-    SAI_TAM_INT_BW_TIME_INTERVAL_896,
+#### 4.4.2 TAM Level Timer Attribute
+Time intervals is configured as part of TAM INT object configuration for CSIG.
 
+```
     /**
-     * @brief Time window 1024
+     * @brief Time interval for bandwidth computation in microseconds
+     *
+     * @type sai_uint32_t
+     * @flags CREATE_AND_SET
+     * @isvlan false
+     * @default 128
+     * @validonly SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE == SAI_CSIG_SIGNAL_TYPE_ABW or SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE == SAI_CSIG_SIGNAL_TYPE_ABWC
      */
-    SAI_TAM_INT_BW_TIME_INTERVAL_1024,
+    SAI_TAM_INT_ATTR_BW_TIME_INTERVAL,
 
-    /**
-     * @brief Vendor defined time window
-     */
-    SAI_TAM_INT_BW_TIME_INTERVAL_VENDOR_DEFINED,
-} sai_tam_int_bw_time_interval_t;
 ```
 
 ### 4.5 TAM INT Object
@@ -249,25 +215,16 @@ This object has recently been enhanced to support the new CSIG INT type, along w
     SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE,
 
     /**
-     * @brief Time interval for bandwidth computation
+     * @brief Time interval for bandwidth computation in microseconds
      *
-     * @type sai_tam_int_bw_time_interval_t
+     * @type sai_uint32_t
      * @flags CREATE_AND_SET
-     * @default SAI_TAM_INT_BW_TIME_INTERVAL_256
+     * @isvlan false
+     * @default 128
      * @validonly SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE == SAI_CSIG_SIGNAL_TYPE_ABW or SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE == SAI_CSIG_SIGNAL_TYPE_ABWC
      */
     SAI_TAM_INT_ATTR_BW_TIME_INTERVAL,
 
-    /**
-     * @brief Bandwidth time Interval Units
-     *
-     * @type sai_tam_int_bw_time_interval_unit_t
-     * @flags CREATE_AND_SET
-     * @default SAI_TAM_INT_BW_TIME_INTERVAL_UNIT_USEC
-     * @validonly SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE == SAI_CSIG_SIGNAL_TYPE_ABW or SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE == SAI_CSIG_SIGNAL_TYPE_ABWC
-     */
-    SAI_TAM_INT_ATTR_BW_TIME_INTERVAL_UNIT,
-
     /**
      * @brief Number of quantization bands
      * Compact tag supports maximum of 32 bands and wide tag supports maximum of 1048576 bands
@@ -279,14 +236,26 @@ This object has recently been enhanced to support the new CSIG INT type, along w
      */
     SAI_TAM_INT_ATTR_QUANT_BANDS,
 
+    /**
+     * @brief Quantization bands identifier
+     * Number of identifiers specified MUST match the number of quantization bands configured for compact tag
+     *
+     * @type sai_u16_list_t
+     * @flags CREATE_AND_SET
+     * @default empty
+     * @validonly SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_CSIG_COMPACT or SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_CSIG_WIDE
+     */
+    SAI_TAM_INT_ATTR_QUANT_BAND_ID,
+
     /**
      * @brief Quantization band range values for compact tag
      *
      * @type sai_u64_range_list_t
      * @flags CREATE_AND_SET
      * @default empty
+     * @validonly SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_CSIG_COMPACT or SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_CSIG_WIDE
      */
-    SAI_TAM_INT_ATTR_QUANT_BAND_UINT32_RANGE_LIST,
+    SAI_TAM_INT_ATTR_QUANT_BAND_UINT64_RANGE_LIST,
 
     /**
      * @brief Base value for wide tag quantization. Must be 0 or power of 2
@@ -303,7 +272,7 @@ This object has recently been enhanced to support the new CSIG INT type, along w
      *
      * @type sai_uint32_t
      * @flags CREATE_AND_SET
-     * @default 0
+     * @default 1
      * @validonly SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_CSIG_WIDE
      */
     SAI_TAM_INT_ATTR_WIDE_QUANT_STEP_VALUE,
@@ -318,17 +287,22 @@ This object has recently been enhanced to support the new CSIG INT type, along w
      * @validonly SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_CSIG_COMPACT or SAI_TAM_INT_ATTR_TYPE == SAI_TAM_INT_TYPE_CSIG_WIDE
      */
     SAI_TAM_INT_ATTR_CSIG_D_BIT,
+
 ```
 
-**New Data Type for u32 list**
+**New Data Type for u64 list**
 ```
-typedef struct _sai_u32_range_list_t
+typedef struct _sai_u64_range_list_t
 {
     uint32_t count;
-    sai_u32_range_t *list;
-} sai_u32_range_list_t;
+    sai_u64_range_t *list;
+} sai_u64_range_list_t;
 ```
 
+**Quantization Band ID**
+Default band id or bucket id for the qunatization is implicit starting from 0 and increases lineraly. 
+New attribute SAI_TAM_INT_ATTR_QUANT_BAND_ID allows NOS to assign a band id or bucket id to individual quantization bands randomly. This is done to support an implementation that may require a mapping to hw index allocation of quantization buckets or may want to map it on e.g. vlan id for overloading hw tables structures. This is an optional feature and can be ignored if not needed.
+
 ### 4.6 ACL Match Fields
 The ACL infrastructure supports matching specific fields within a packet and is enhanced to include CSIG tag fields. This functionality is crucial for developing policies based on CSIG tags with flags set, as explained further in the workflow section.
 New match for compact and wide tag EtherType and Signal type is introduced. 
@@ -341,19 +315,20 @@ New match for compact and wide tag EtherType and Signal type is introduced.
  */
 typedef enum _sai_csig_signal_type_t
 {
-    /** Available Bandwidth */
+    /** Available Bandwidth in bytes per second */
     SAI_CSIG_SIGNAL_TYPE_ABW = 0,
 
-    /** Normalized Available Bandwidth */
+    /** Normalized Available Bandwidth in percentage */
     SAI_CSIG_SIGNAL_TYPE_ABWC = 1,
 
-    /** Delay */
+    /** Delay in nanoseconds */
     SAI_CSIG_SIGNAL_TYPE_DELAY = 2,
 
-    /** Normalized Queue Depth */
+    /** Normalized Queue Depth, in flight bytes divided by normalized port speed */
     SAI_CSIG_SIGNAL_TYPE_NQD = 3,
 
 } sai_csig_signal_type_t;
+
 ```
 
 **Table Fields**
@@ -481,6 +456,16 @@ Switch attribute specifies number of bandwidth timers a given implementation sup
      * @flags READ_ONLY
      */
     SAI_SWITCH_ATTR_MAX_CSIG_TIMERS,
+
+    /**
+     * @brief CSIG Bandwidth time intervals supported in microseconds valid only for available and relative available bandwidth signal type
+     *
+     * @type sai_u32_list_t
+     * @flags READ_ONLY
+     */
+    SAI_SWITCH_ATTR_CSIG_BW_TIME_INTERVAL_IN_USEC,
+
+
 ```
 
 
@@ -517,13 +502,9 @@ sai_attr_list[1].value.u16 = 0xccdd;
 sai_attr_list[2].id = SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE;
 sai_attr_list[2].value.s32 = SAI_CSIG_SIGNAL_TYPE_ABW;
 
-// Configure Time Interval
+// Configure Time Interval in usec
 sai_attr_list[3].id = SAI_TAM_INT_ATTR_BW_TIME_INTERVAL;
-sai_attr_list[3].value.s32 = SAI_TAM_INT_BW_TIME_INTERVAL_256;
-
-// Configure Time Interval Unit
-sai_attr_list[4].id = SAI_TAM_INT_ATTR_BW_TIME_INTERVAL_UNIT;
-sai_attr_list[4].value.s32 = SAI_TAM_INT_BW_TIME_INTERVAL_UNIT_USEC;
+sai_attr_list[3].value.u32 = 256;
 
 // Configure Range List for each band
 sai_attr_list[5].id = SSAI_TAM_INT_ATTR_QUANT_BANDS;
@@ -594,7 +575,14 @@ Create TAM objects as described in section 5.1.1 and 5.1.2
 Step 2:
 Install an ACL rule to match CSIG ethtype and set the action as insert and bind the ACL Table to the switch
 - match <SAI_ACL_ENTRY_ATTR_FIELD_CSIG_COMPACT_ETHER_TYPE> action <SAI_ACL_ENTRY_ATTR_ACTION_INT_INSERT,  sai_tam_int_csig_compact_tag_object>
-- match <SAI_ACL_ENTRY_ATTR_FIELD_CSIG_WIDE_ETHER_TYPE> action <SAI_ACL_ENTRY_ATTR_ACTION_INT_INSERT,  sai_tam_int_csig_wide_tag_object>
+- match <SAI_ACL_ENTRY_ATTR_FIELD_CSIG_WIDE_ETHER_TYPE> action <SAI_ACL_ENTRY_ATTR_ACTION_INT_INSERT,  sai_tam_int_csig_wide_tag_object>
+
+or
+
+Step2:
+
+Create a contain TAM object for TAM INT object and bind it to switch attribute SAI_SWITCH_ATTR_TAM_OBJECT_ID. Mutiple TAM INT objects can be created under single TAM object to support different signal types and time intervals.
+
 
 #### 5.1.4 Enable CSIG for subset of ingress ports
 Step 1:

inc/saiswitch.h

@@ -3558,6 +3558,14 @@ typedef enum _sai_switch_attr_t
      */
     SAI_SWITCH_ATTR_MAX_CSIG_TIMERS,
 
+    /**
+     * @brief CSIG Bandwidth time intervals supported in microseconds valid only for available and relative available bandwidth signal type
+     *
+     * @type sai_u32_list_t
+     * @flags READ_ONLY
+     */
+    SAI_SWITCH_ATTR_CSIG_BW_TIME_INTERVAL_IN_USEC,
+
     /**
      * @brief End of attributes
      */

inc/saitam.h

@@ -836,22 +836,14 @@ typedef enum _sai_tam_int_attr_t
     /**
      * @brief Time interval for bandwidth computation in microseconds
      *
-     * @type sai_uint16_t
+     * @type sai_uint32_t
      * @flags CREATE_AND_SET
      * @isvlan false
      * @default 128
      * @validonly SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE == SAI_CSIG_SIGNAL_TYPE_ABW or SAI_TAM_INT_ATTR_CSIG_SIGNAL_TYPE == SAI_CSIG_SIGNAL_TYPE_ABWC
      */
     SAI_TAM_INT_ATTR_BW_TIME_INTERVAL,
 
-    /**
-     * @brief Bandwidth time intervals supported in microseconds valid only for available and relative available bandwidth signal type
-     *
-     * @type sai_u16_list_t
-     * @flags READ_ONLY
-     */
-    SAI_TAM_INT_ATTR_BW_TIME_INTERVAL_IN_USEC,
-
     /**
      * @brief Number of quantization bands
      * Compact tag supports maximum of 32 bands and wide tag supports maximum of 1048576 bands