Collect module EEPROM data in dump

[Junchao-Mellanox]

What I did

Add a new CLI sfputil eeprom-hexdump-all to dump all pages for module
Support collecting module EEPROM in show techsupport command

How I did it

HLD: sonic-net/SONiC#1476

How to verify it

Manual test
Unit test
Regression test

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

EEPROM hexdump for module 1
        Lower page 0h
        00000000 11 08 06 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000010 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000020 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000030 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000040 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000050 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000060 00 00 00 00 00 00 00 00  00 00 00 00 00 01 08 00 |................|
        00000070 00 10 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        Upper page 0h
        00000000 11 08 06 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000010 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000020 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000030 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000040 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000050 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000060 00 00 00 00 00 00 00 00  00 00 00 00 00 01 08 00 |................|
        00000070 00 10 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        Page 1h
        00000000 11 08 06 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000010 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000020 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000030 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000040 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000050 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
        00000060 00 00 00 00 00 00 00 00  00 00 00 00 00 01 08 00 |................|
        00000070 00 10 00 00 00 00 00 00  00 00 00 00 00 00 00 00 |................|
...
EEPROM hexdump for module 2
...

[prgeor]

@Junchao-Mellanox could you please update the command ref doc https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md

[Junchao-Mellanox]

Hi @prgeor , I checked command reference doc, it mentioned:

  3. sonic-clear, sfputil, etc., This document does not explain these scripts also.

So, it seems that we don't add doc for sfputil.

[prgeor]

Hi @prgeor , I checked command reference doc, it mentioned:

  3. sonic-clear, sfputil, etc., This document does not explain these scripts also.

So, it seems that we don't add doc for sfputil.

@Junchao-Mellanox we can remove that statement. Recently we added sfputil firmware download command to this doc. It will be good to capture all CLIs in this Repo in one doc

[prgeor]

@Junchao-Mellanox I would suggest to enhance existing APIs: eeprom_hexdump_sff8472() to eeprom_hexdump_sff8472(port, physical_port, pages). Let the caller take care of what pages or list of pages to pass based upon if the cable support only flat memory, if cable is CMIS, SFF etc.. This way we can reuse existing API. You can take approach of is_xcvr_optical() (see sonic-mgmt repo) to know if SFP+ is copper or not.

[Junchao-Mellanox]

@Junchao-Mellanox I would suggest to enhance existing APIs: eeprom_hexdump_sff8472() to eeprom_hexdump_sff8472(port, physical_port, pages). Let the caller take care of what pages or list of pages to pass based upon if the cable support only flat memory, if cable is CMIS, SFF etc.. This way we can reuse existing API. You can take approach of is_xcvr_optical() (see sonic-mgmt repo) to know if SFP+ is copper or not.

Hi @prgeor ,
I was thinking of reusing eeprom_hexdump_sff8472. But I found it is very difficult. eeprom_hexdump_sff8472 is designed for single port:

1. There are many code like sys.exit(ERROR_NOT_IMPLEMENTED). It would exit the CLI if any port got unexpected result. This is not expected for multi ports dump.
2. It dumps EEPROM for logical port like Ethernet0, Ethernet4. This is OK for single port, but not so good for multi port dump. For multi port dump, I choose to dump eeprom for physical port so that split port won't be dump many times.

I understand your point is to reuse existing code and keep the design clean. I totally agree with that. So, how about this:
I will totally replace eeprom_hexdump_sff8472 with dump_eeprom_pages_sff8472 in a future PR. I don't want to do it in current PR because:

1. I don't want to take the risk to break existing function (to change the logic for single port).
2. It would be a major change to replace it
3. single port dump is not scope of my feature

[liat-grozovik]

@prgeor could you please help to review feedback changes?
this is needed for 202311

[prgeor]

@mihirpat1 could you also please review?

[keboliu]

@prgeor @mihirpat1 could you please sign-off?

[prgeor]

@Junchao-Mellanox please check cherry-pick conflict