Add support for custom serdes attributes by longhuan-cisco · Pull Request #643 · sonic-net/sonic-platform-daemons

longhuan-cisco · 2025-07-14T22:09:47Z

sonic-swss side change: sonic-net/sonic-swss#3764

Description

Add support for custom serdes attrs SAI_PORT_SERDES_ATTR_CUSTOM_COLLECTION

In media_settings.json, custom attributes can be defined by using CUSTOM: as prefix, and existing parsing logic/format will be reused.

Example media_settings.json snippet

                    "CUSTOM:ABC": {
                        "lane0": "0x1",
                        "lane1": "0x1",
                        "lane2": "0x1",
                        "lane3": "0x1",
                        "lane4": "0x1",
                        "lane5": "0x1",
                        "lane6": "0x1",
                        "lane7": "0x1"
                    },
                    "CUSTOM:XYZ": {
                        "lane0": "0x10",
                        "lane1": "0x10",
                        "lane2": "0x10",
                        "lane3": "0x10",
                        "lane4": "0x10",
                        "lane5": "0x10",
                        "lane6": "0x10",
                        "lane7": "0x10"
                    },
                    "CUSTOM:XXX": {
                        "lane0": "0x7",
                        "lane1": "0x7",
                        "lane2": "0x7",
                        "lane3": "0x7",
                        "lane4": "0x7",
                        "lane5": "0x7",
                        "lane6": "0x7",
                        "lane7": "0x7"
                    },

Motivation and Context

How Has This Been Tested?

Tested end-to-end xcvrd->OA->SAI/SDK on 8-hostlanes optics with both non-breakout and breakout modes.

Additional Information (Optional)

mssonicbld · 2025-07-14T22:09:55Z

/azp run

azure-pipelines · 2025-07-14T22:10:03Z

Azure Pipelines successfully started running 1 pipeline(s).

longhuan-cisco · 2025-07-14T23:17:46Z

@prgeor @mihirpat1 could you please review, thanks

mssonicbld · 2025-09-02T20:31:07Z

/azp run

azure-pipelines · 2025-09-02T20:31:17Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

This PR adds support for custom SerDes attributes in the media settings parser, allowing custom attributes to be defined in media_settings.json with a CUSTOM: prefix and converted to JSON format for consumption by the SAI layer.

Introduces parsing logic for custom SerDes attributes prefixed with CUSTOM:
Adds conversion functions to handle hex/int string values and convert them to signed integers
Implements JSON serialization of custom attributes for database storage

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py	Adds custom SerDes attribute parsing logic, helper functions for string-to-int conversion, and integration into the media setting notification flow
sonic-xcvrd/tests/test_xcvrd.py	Adds unit tests for the custom SerDes attribute handling functionality

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py

mssonicbld · 2025-10-20T23:38:12Z

/azp run

azure-pipelines · 2025-10-20T23:38:21Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-10-27T07:28:00Z

/azp run

azure-pipelines · 2025-10-27T07:28:09Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-10-27T18:43:38Z

/azp run

azure-pipelines · 2025-10-27T18:43:47Z

Azure Pipelines successfully started running 1 pipeline(s).

sonic-platform-daemon side change: sonic-net/sonic-platform-daemons#643 What I did Support SAI_PORT_SERDES_ATTR_CUSTOM_COLLECTION (i.e. custom serdes attributes represented in JSON based string format) Use boost::variant for the serdes_attr map value to support both std::vector<uint32_t> and std::string in a type-safe way, with easy extensibility to add more types later.

longhuan-cisco · 2025-11-26T23:26:21Z

@prgeor kindly reminder, thanks

prgeor · 2025-11-27T01:47:04Z

sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py

    return port_speed, lane_count, subport_num


+def convert_to_int32(value):


@longhuan-cisco I am not sure why custom values need this conversion compared to existing SI values

@prgeor Agree, changed it to take custom attr values as-is from media_settings.json
It's up to the vendor/platform to use whatever types of values.

prgeor · 2025-11-27T01:55:11Z

@longhuan-cisco can we have an HLD describing this ? We have similar for GLOBAL_MEDIA_SETTINGS , PORT_MEDIA_SETTINGS here. ?

We can have CUSTOM_MEDIA_SETTINGS

mssonicbld · 2025-12-06T00:40:33Z

/azp run

azure-pipelines · 2025-12-06T00:40:41Z

Azure Pipelines successfully started running 1 pipeline(s).

longhuan-cisco · 2025-12-06T00:53:36Z

@longhuan-cisco can we have an HLD describing this ? We have similar for GLOBAL_MEDIA_SETTINGS , PORT_MEDIA_SETTINGS here. ?

@prgeor
Sure will update HLD https://github.com/sonic-net/SONiC/blob/master/doc/media-settings/Media-based-Port-settings.md

We can have CUSTOM_MEDIA_SETTINGS

Were you suggesting to put custom attributes in a new CUSTOM_MEDIA_SETTINGS section of media_settings.json? I'm not sure about the advantage of doing so.
Instead, by putting all the custom attributes in existing GLOBAL_MEDIA_SETTINGS and PORT_MEDIA_SETTINGS in the same way as traditional attributes (only difference is the CUSTOM: prefix), both traditional and custom attributes are able to share the same parsing logic (without touching the existing main parsing logic), custom attributes automatically obtain all the existing good stuff of today's parser (range ports support, DEFAULT_KEY, vendor+PN matching, regex key matching, media_lane_speed_key, etc) and inherit any potential future enhancement for free.

sonic-platform-daemons/sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py

Lines 249 to 300 in 99a4594

    
           if GLOBAL_MEDIA_SETTINGS_KEY in g_dict: 
        
               for keys in g_dict[GLOBAL_MEDIA_SETTINGS_KEY]: 
        
                   if COMMA_SEPARATOR in keys: 
        
                       port_list = keys.split(COMMA_SEPARATOR) 
        
                       for port in port_list: 
        
                           if RANGE_SEPARATOR in port: 
        
                               if common.check_port_in_range(port, physical_port): 
        
                                   media_dict = g_dict[GLOBAL_MEDIA_SETTINGS_KEY][keys] 
        
                                   break 
        
                           elif str(physical_port) == port: 
        
                               media_dict = g_dict[GLOBAL_MEDIA_SETTINGS_KEY][keys] 
        
                               break 
        
                   elif RANGE_SEPARATOR in keys: 
        
                       if common.check_port_in_range(keys, physical_port): 
        
                           media_dict = g_dict[GLOBAL_MEDIA_SETTINGS_KEY][keys] 
        
                   # If there is a match in the global profile for a media type, 
        
                   # fetch those values 
        
                   media_settings = get_media_settings(key, media_dict) 
        
                   if media_settings is not None: 
        
                       return media_settings 
        
                   # Try to match 'default' key if it does not match any keys 
        
                   elif DEFAULT_KEY in media_dict: 
        
                       default_dict = get_media_settings_for_speed(media_dict[DEFAULT_KEY], lane_speed_key) 
        
           media_dict = {} 
        
           if PORT_MEDIA_SETTINGS_KEY in g_dict: 
        
               for keys in g_dict[PORT_MEDIA_SETTINGS_KEY]: 
        
                   if int(keys) == physical_port: 
        
                       media_dict = g_dict[PORT_MEDIA_SETTINGS_KEY][keys] 
        
                       break 
        
               if len(media_dict) == 0: 
        
                   if len(default_dict) != 0: 
        
                       return default_dict 
        
                   else: 
        
                       helper_logger.log_notice("No values for physical port '{}'".format(physical_port)) 
        
                   return {} 
        
               media_settings = get_media_settings(key, media_dict) 
        
               if media_settings is not None: 
        
                   return media_settings 
        
               # Try to match 'default' key if it does not match any keys 
        
               elif DEFAULT_KEY in media_dict: 
        
                   return get_media_settings_for_speed(media_dict[DEFAULT_KEY], lane_speed_key) 
        
               elif len(default_dict) != 0: 
        
                   return default_dict 
        
           else: 
        
               if len(default_dict) != 0: 
        
                   return default_dict

Signed-off-by: Longyin Huang <longhuan@cisco.com>

…des attrs Signed-off-by: Longyin Huang <longhuan@cisco.com>

Signed-off-by: Longyin Huang <longhuan@cisco.com>

mssonicbld · 2025-12-06T01:05:14Z

/azp run

azure-pipelines · 2025-12-06T01:05:22Z

Azure Pipelines successfully started running 1 pipeline(s).

sonic-platform-daemon side change: sonic-net/sonic-platform-daemons#643 What I did Support SAI_PORT_SERDES_ATTR_CUSTOM_COLLECTION (i.e. custom serdes attributes represented in JSON based string format) Use boost::variant for the serdes_attr map value to support both std::vector<uint32_t> and std::string in a type-safe way, with easy extensibility to add more types later. Signed-off-by: Kalash Nainwal <kalash@nexthop.ai>

sonic-platform-daemon side change: sonic-net/sonic-platform-daemons#643 What I did Support SAI_PORT_SERDES_ATTR_CUSTOM_COLLECTION (i.e. custom serdes attributes represented in JSON based string format) Use boost::variant for the serdes_attr map value to support both std::vector<uint32_t> and std::string in a type-safe way, with easy extensibility to add more types later.

sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py

prgeor · 2026-01-06T21:26:57Z

@longhuan-cisco can we have an HLD describing this ? We have similar for GLOBAL_MEDIA_SETTINGS , PORT_MEDIA_SETTINGS here. ?

@prgeor Sure will update HLD https://github.com/sonic-net/SONiC/blob/master/doc/media-settings/Media-based-Port-settings.md

We can have CUSTOM_MEDIA_SETTINGS

Were you suggesting to put custom attributes in a new CUSTOM_MEDIA_SETTINGS section of media_settings.json? I'm not sure about the advantage of doing so. Instead, by putting all the custom attributes in existing GLOBAL_MEDIA_SETTINGS and PORT_MEDIA_SETTINGS in the same way as traditional attributes (only difference is the CUSTOM: prefix), both traditional and custom attributes are able to share the same parsing logic (without touching the existing main parsing logic), custom attributes automatically obtain all the existing good stuff of today's parser (range ports support, DEFAULT_KEY, vendor+PN matching, regex key matching, media_lane_speed_key, etc) and inherit any potential future enhancement for free.

sonic-platform-daemons/sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py

Lines 249 to 300 in 99a4594

if GLOBAL_MEDIA_SETTINGS_KEY in g_dict:

for keys in g_dict[GLOBAL_MEDIA_SETTINGS_KEY]:

if COMMA_SEPARATOR in keys:

port_list = keys.split(COMMA_SEPARATOR)

for port in port_list:

if RANGE_SEPARATOR in port:

if common.check_port_in_range(port, physical_port):

media_dict = g_dict[GLOBAL_MEDIA_SETTINGS_KEY][keys]

break

elif str(physical_port) == port:

media_dict = g_dict[GLOBAL_MEDIA_SETTINGS_KEY][keys]

break

elif RANGE_SEPARATOR in keys:

if common.check_port_in_range(keys, physical_port):

media_dict = g_dict[GLOBAL_MEDIA_SETTINGS_KEY][keys]

# If there is a match in the global profile for a media type,

# fetch those values

media_settings = get_media_settings(key, media_dict)

if media_settings is not None:

return media_settings

# Try to match 'default' key if it does not match any keys

elif DEFAULT_KEY in media_dict:

default_dict = get_media_settings_for_speed(media_dict[DEFAULT_KEY], lane_speed_key)

media_dict = {}

if PORT_MEDIA_SETTINGS_KEY in g_dict:

for keys in g_dict[PORT_MEDIA_SETTINGS_KEY]:

if int(keys) == physical_port:

media_dict = g_dict[PORT_MEDIA_SETTINGS_KEY][keys]

break

if len(media_dict) == 0:

if len(default_dict) != 0:

return default_dict

else:

helper_logger.log_notice("No values for physical port '{}'".format(physical_port))

return {}

media_settings = get_media_settings(key, media_dict)

if media_settings is not None:

return media_settings

# Try to match 'default' key if it does not match any keys

elif DEFAULT_KEY in media_dict:

return get_media_settings_for_speed(media_dict[DEFAULT_KEY], lane_speed_key)

elif len(default_dict) != 0:

return default_dict

else:

if len(default_dict) != 0:

return default_dict

@longhuan-cisco do you have the PR for HLD?

longhuan-cisco · 2026-01-07T20:12:45Z

do you have the PR for HLD?

@prgeor sonic-net/SONiC#2173

Signed-off-by: Longyin Huang <longhuan@cisco.com>

mssonicbld · 2026-01-10T01:29:53Z

/azp run

azure-pipelines · 2026-01-10T01:30:03Z

Azure Pipelines successfully started running 1 pipeline(s).

sonic-platform-daemon side change: sonic-net/sonic-platform-daemons#643 What I did Support SAI_PORT_SERDES_ATTR_CUSTOM_COLLECTION (i.e. custom serdes attributes represented in JSON based string format) Use boost::variant for the serdes_attr map value to support both std::vector<uint32_t> and std::string in a type-safe way, with easy extensibility to add more types later.

- add CUSTOM_MEDIA_SETTINGS lookup with shared media key matching - convert custom SerDes attrs into custom_serdes_attrs JSON payload - add selector parsing + tests for custom media settings and notify path Signed-off-by: Longyin Huang <longhuan@cisco.com>

mssonicbld · 2026-02-04T21:14:20Z

/azp run

azure-pipelines · 2026-02-04T21:14:26Z

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.

mssonicbld · 2026-02-04T23:33:46Z

/azp run

azure-pipelines · 2026-02-04T23:33:56Z

Azure Pipelines successfully started running 1 pipeline(s).

…rdes

mssonicbld · 2026-02-04T23:51:39Z

/azp run

azure-pipelines · 2026-02-04T23:51:49Z

Azure Pipelines successfully started running 1 pipeline(s).

sonic-platform-daemon side change: sonic-net/sonic-platform-daemons#643 What I did Support SAI_PORT_SERDES_ATTR_CUSTOM_COLLECTION (i.e. custom serdes attributes represented in JSON based string format) Use boost::variant for the serdes_attr map value to support both std::vector<uint32_t> and std::string in a type-safe way, with easy extensibility to add more types later. Signed-off-by: Baorong Liu <96146196+baorliu@users.noreply.github.com>

prgeor · 2026-02-24T01:27:04Z

sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py

+
+    return None
+
+def is_port_selected(port_selector, physical_port):


@longhuan-cisco can we keep the parsing for port ',' and '-' parsing similar to done in GLOBAL_MEDIA_SETTINGS_KEY

@prgeor
The code here is achieving the same functionality as GLOBAL_MEDIA_SETTINGS_KEY in terms of parsing ',' and '-', just written in a cleaner way.
The only additional thing here is: print notice syslog messages to tell syntax error of ranged-ports key instead of silently ignoring it.
The code here is only consumed by CUSTOM_MEDIA_SETTINGS. The GLOBAL_MEDIA_SETTINGS still relies on the existing ranged-ports parsing code <-- I didn't touch that part.

Please let me know if you really prefer a copy-paste duplication of the original ranged-port parsing code of GLOBAL_MEDIA_SETTINGS_KEY.

prgeor · 2026-02-25T05:34:41Z

@longhuan-cisco I have opened this refactor PR and should make things easier for you. can you please review?

longhuan-cisco · 2026-02-25T23:09:43Z

@longhuan-cisco I have opened this refactor PR and should make things easier for you. can you please review?

@prgeor Thanks for the refactor — this is heading in a nice direction.
Sure

longhuan-cisco mentioned this pull request Jul 14, 2025

Support SAI_PORT_SERDES_ATTR_CUSTOM_COLLECTION sonic-net/sonic-swss#3764

Merged

mihirpat1 requested a review from Copilot October 15, 2025 02:56

Copilot AI reviewed Oct 15, 2025

View reviewed changes

sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py Outdated Show resolved Hide resolved

sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py Outdated Show resolved Hide resolved

sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py Outdated Show resolved Hide resolved

mihirpat1 approved these changes Oct 31, 2025

View reviewed changes

prgeor reviewed Nov 27, 2025

View reviewed changes

longhuan-cisco added 6 commits December 5, 2025 16:56

Add support for custom serdes attributes

528b038

Signed-off-by: Longyin Huang <longhuan@cisco.com>

Support deceimal int value

64d2fdd

Signed-off-by: Longyin Huang <longhuan@cisco.com>

Add error handling and bounds checking for input data

5959b94

Signed-off-by: Longyin Huang <longhuan@cisco.com>

Update to accept integer or hex string value for custom serdes attrs

629718e

Signed-off-by: Longyin Huang <longhuan@cisco.com>

Update to allow hex string, decimal string and integer for custom ser…

eebd342

…des attrs Signed-off-by: Longyin Huang <longhuan@cisco.com>

Take custom attr values as-is from media_settings.json

e7c8400

Signed-off-by: Longyin Huang <longhuan@cisco.com>

longhuan-cisco force-pushed the support_custom_serdes branch from 8aa21fb to e7c8400 Compare December 6, 2025 01:05

longhuan-cisco requested a review from prgeor December 6, 2025 01:19

prgeor reviewed Jan 6, 2026

View reviewed changes

sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py Show resolved Hide resolved

prgeor reviewed Jan 6, 2026

View reviewed changes

sonic-xcvrd/xcvrd/xcvrd_utilities/media_settings_parser.py Show resolved Hide resolved

longhuan-cisco mentioned this pull request Jan 7, 2026

Update Media-based-Port-settings.md to support custom SerDes attributes sonic-net/SONiC#2173

Merged

longhuan-cisco requested a review from prgeor January 7, 2026 20:12

Add early gating for custom SerDes attributes handling

27dfe58

Signed-off-by: Longyin Huang <longhuan@cisco.com>

Merge remote-tracking branch 'upstream/master' into support_custom_se…

3858b95

…rdes

longhuan-cisco force-pushed the support_custom_serdes branch from 711fb17 to 3858b95 Compare February 4, 2026 23:51

prgeor reviewed Feb 24, 2026

View reviewed changes

		return port_speed, lane_count, subport_num


		def convert_to_int32(value):


		return None

		def is_port_selected(port_selector, physical_port):

Conversation

longhuan-cisco commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Additional Information (Optional)

Uh oh!

mssonicbld commented Jul 14, 2025

Uh oh!

azure-pipelines bot commented Jul 14, 2025

Uh oh!

longhuan-cisco commented Jul 14, 2025

Uh oh!

mssonicbld commented Sep 2, 2025

Uh oh!

azure-pipelines bot commented Sep 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mssonicbld commented Oct 20, 2025

Uh oh!

azure-pipelines bot commented Oct 20, 2025

Uh oh!

mssonicbld commented Oct 27, 2025

Uh oh!

azure-pipelines bot commented Oct 27, 2025

Uh oh!

mssonicbld commented Oct 27, 2025

Uh oh!

azure-pipelines bot commented Oct 27, 2025

Uh oh!

longhuan-cisco commented Nov 26, 2025

Uh oh!

prgeor Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

longhuan-cisco Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

prgeor commented Nov 27, 2025

Uh oh!

mssonicbld commented Dec 6, 2025

Uh oh!

azure-pipelines bot commented Dec 6, 2025

Uh oh!

longhuan-cisco commented Dec 6, 2025

Uh oh!

mssonicbld commented Dec 6, 2025

Uh oh!

azure-pipelines bot commented Dec 6, 2025

Uh oh!

Uh oh!

Uh oh!

prgeor commented Jan 6, 2026

Uh oh!

longhuan-cisco commented Jan 7, 2026

Uh oh!

mssonicbld commented Jan 10, 2026

Uh oh!

azure-pipelines bot commented Jan 10, 2026

Uh oh!

mssonicbld commented Feb 4, 2026

Uh oh!

azure-pipelines bot commented Feb 4, 2026

Uh oh!

mssonicbld commented Feb 4, 2026

Uh oh!

azure-pipelines bot commented Feb 4, 2026

Uh oh!

mssonicbld commented Feb 4, 2026

Uh oh!

azure-pipelines bot commented Feb 4, 2026

longhuan-cisco commented Jul 14, 2025 •

edited

Loading

longhuan-cisco Dec 6, 2025 •

edited

Loading

longhuan-cisco Feb 24, 2026 •

edited

Loading