Implement vpd-tool mfgClean #573

souvik1914581 · 2025-01-09T18:10:35Z

his commit implements vpd-tool --mfgClean option.
This API resets specific System VPD keywords to default value.

The specified keyword values are reset on:
- Primary EEPROM path.
- Redundant EEPROM path(if any)
- D-Bus cache.
- Backup path.

This commit implements vpd-tool --mfgClean option. This API resets specific System VPD keywords to default value. The specified keyword values are reset on: - Primary EEPROM path. - Redundant EEPROM path(if any) - D-Bus cache. - Backup path. Test: ``` root@p10bmc:~# ./vpd-tool --mfgClean --yes Cleaning System VPD... Hardware path: "/sys/bus/i2c/drivers/at24/8-0050/eeprom" Data updated successfully Data updated successfully Data updated successfully The critical keywords from system backplane VPD has been reset successfully. root@p10bmc:~# ./vpd-tool --mfgClean This option resets some of the system VPD keywords to their default values. Do you really wish to proceed further?[yes/no]:yes Cleaning System VPD... Hardware path: "/sys/bus/i2c/drivers/at24/8-0050/eeprom" The critical keywords from system backplane VPD has been reset successfully. ``` Change-Id: I55862fc4122a188e3e522dd64ed6bd1fa94335e8 Signed-off-by: Souvik Roy <souvik.roy10@ibm.com>

This commit implements vpd-tool --mfgClean option. This API resets specific System VPD keywords to default value. The System VPD keywords are fetched from backup_restore.json. The specified keyword values are reset on: - Primary EEPROM path. - Redundant EEPROM path(if any) - D-Bus cache. - Backup path. Test: ``` root@p10bmc:~# ./vpd-tool --mfgClean --yes Cleaning System VPD... Hardware path: "/sys/bus/i2c/drivers/at24/8-0050/eeprom" Data updated successfully Data updated successfully Data updated successfully The critical keywords from system backplane VPD has been reset successfully. root@p10bmc:~# ./vpd-tool --mfgClean This option resets some of the system VPD keywords to their default values. Do you really wish to proceed further?[yes/no]:yes Cleaning System VPD... Hardware path: "/sys/bus/i2c/drivers/at24/8-0050/eeprom" The critical keywords from system backplane VPD has been reset successfully. ``` Change-Id: I55862fc4122a188e3e522dd64ed6bd1fa94335e8 Signed-off-by: Souvik Roy <souvik.roy10@ibm.com>

jinuthomas · 2025-01-13T04:00:06Z

vpd-tool/src/vpd_tool.cpp

@@ -197,21 +197,128 @@ int VpdTool::cleanSystemVpd() const noexcept
    int l_rc{constants::FAILURE};
    try
    {
-        // TODO:
        //     get the keyword map from backup_restore json
        //     iterate through the keyword map get default value of
        //     l_keywordName.
        //     use readKeyword API to read hardware value from hardware.


read is not required, write directly to clear the mfg values

Removed read.

jinuthomas · 2025-01-13T04:19:52Z

vpd-tool/src/vpd_tool.cpp

+                                .get<types::BinaryVector>();
+
+                        // get the value on hardware
+                        const auto& l_keywordValue =


skip the read check and go ahead with the write check

Removed read check.

jinuthomas · 2025-01-13T04:21:16Z

vpd-tool/src/vpd_tool.cpp

+        {
+            l_rc = constants::SUCCESS;
+            std::cout
+                << "\n The critical keywords from system backplane VPD has "


why system backplane ?

That's the string the old vpd-tool prints out on success.

We need to fix that now :)

Updated the success/failure message.

This commit implements vpd-tool --mfgClean option. This API resets specific System VPD keywords to default value. The System VPD keywords are fetched from backup_restore.json. The specified keyword values are reset on: - Primary EEPROM path. - Redundant EEPROM path(if any) - D-Bus cache. - Backup path. Test: ``` root@p10bmc:~# ./vpd-tool --mfgClean --yes Cleaning System VPD... Hardware path: "/sys/bus/i2c/drivers/at24/8-0050/eeprom" Data updated successfully Data updated successfully Data updated successfully The critical keywords from system backplane VPD has been reset successfully. root@p10bmc:~# ./vpd-tool --mfgClean This option resets some of the system VPD keywords to their default values. Do you really wish to proceed further?[yes/no]:yes Cleaning System VPD... Hardware path: "/sys/bus/i2c/drivers/at24/8-0050/eeprom" The critical keywords from system backplane VPD has been reset successfully. ``` Change-Id: I55862fc4122a188e3e522dd64ed6bd1fa94335e8 Signed-off-by: Souvik Roy <souvik.roy10@ibm.com>

This commit implements vpd-tool --mfgClean option. This API resets specific System VPD keywords to default value. The System VPD keywords are fetched from backup_restore.json. The specified keyword values are reset on: - Primary EEPROM path. - Redundant EEPROM path(if any) - D-Bus cache. - Backup path. Test: ``` root@p10bmc:~# ./vpd-tool --mfgClean --yes Manufacturing clean is successful root@p10bmc:~# ./vpd-tool --mfgClean This option resets some of the system VPD keywords to their default values. Do you really wish to proceed further?[yes/no]:yes Manufacturing clean is successful ``` Change-Id: I55862fc4122a188e3e522dd64ed6bd1fa94335e8 Signed-off-by: Souvik Roy <souvik.roy10@ibm.com>

vpd-tool/src/vpd_tool.cpp

jinuthomas · 2025-01-13T08:06:02Z

vpd-tool/src/vpd_tool.cpp

+                    else
+                    {
+                        std::cerr
+                            << "Invalid keyword entry in Backup Restore JSON backup map"


keep this statement generic like below
"Unrecognized Entry Record [l_srcRecordName] Keyword [l_srcKeywordName]"

jinuthomas · 2025-01-13T08:07:23Z

vpd-tool/src/vpd_tool.cpp

+            getBackupRestoreCfgJsonObj();
+
+        // flag to track any failure
+        bool l_anyFailure{false};


is this even needed ?

Yes, to detemine the status message printed to console
"Manufacturing clean is success" or
"Manufacturing clean has failed"

I am still confused on when this will be false on the final print. if I have a single backup map with a single entry and mfgclean is not required what will the end display be ?

Removed the flag.

jinuthomas · 2025-01-13T08:08:50Z

vpd-tool/src/vpd_tool.cpp

    }
-    return l_rc;
+    return constants::SUCCESS; // keeping rc=0 always for consistency with old
+                               // 1060 mfgClean implementation


this comment need not be there

Removed the comment.

This commit implements vpd-tool --mfgClean option. This API resets specific System VPD keywords to default value. The System VPD keywords are fetched from backup_restore.json. The specified keyword values are reset on: - Primary EEPROM path. - Redundant EEPROM path(if any) - D-Bus cache. - Backup path. Test: ``` root@p10bmc:~# ./vpd-tool --mfgClean --yes Manufacturing clean is successful root@p10bmc:~# ./vpd-tool --mfgClean This option resets some of the system VPD keywords to their default values. Do you really wish to proceed further?[yes/no]:yes Manufacturing clean is successful ``` Change-Id: I55862fc4122a188e3e522dd64ed6bd1fa94335e8 Signed-off-by: Souvik Roy <souvik.roy10@ibm.com>

jinuthomas · 2025-01-13T08:43:38Z

vpd-tool/src/vpd_tool.cpp

+            getBackupRestoreCfgJsonObj();
+
+        // flag to track any failure
+        bool l_anyFailure{false};


I am still confused on when this will be false on the final print. if I have a single backup map with a single entry and mfgclean is not required what will the end display be ?

vpd-tool/src/vpd_tool.cpp

This commit implements vpd-tool --mfgClean option. This API resets specific System VPD keywords to default value. The System VPD keywords are fetched from backup_restore.json. The specified keyword values are reset on: - Primary EEPROM path. - Redundant EEPROM path(if any) - D-Bus cache. - Backup path. Test: ``` root@p10bmc:~# ./vpd-tool --mfgClean --yes Manufacturing clean is successful root@p10bmc:~# ./vpd-tool --mfgClean This option resets some of the system VPD keywords to their default values. Do you really wish to proceed further?[yes/no]:yes Manufacturing clean is successful ``` Change-Id: I55862fc4122a188e3e522dd64ed6bd1fa94335e8 Signed-off-by: Souvik Roy <souvik.roy10@ibm.com>

souvik1914581 marked this pull request as draft January 9, 2025 18:10

souvik1914581 force-pushed the sr_vpdToolMfgClean_backupRestoreJson branch 4 times, most recently from 0a0fe28 to 27ab26f Compare January 10, 2025 07:03

souvik1914581 force-pushed the sr_vpdToolMfgClean_backupRestoreJson branch from 27ab26f to a45585e Compare January 10, 2025 07:05

This was referenced Jan 10, 2025

Implement vpd-tool mfgClean option #515

Closed

Implement vpd-tool mfgClean #569

Closed

souvik1914581 changed the title ~~Implement vpd-tool mfgClean(using backupRestore JSON)~~ Implement vpd-tool mfgClean Jan 10, 2025

souvik1914581 force-pushed the sr_vpdToolMfgClean_backupRestoreJson branch from a45585e to 53ec284 Compare January 10, 2025 07:12

souvik1914581 force-pushed the sr_vpdToolMfgClean_backupRestoreJson branch from 53ec284 to 933e808 Compare January 10, 2025 09:37

souvik1914581 marked this pull request as ready for review January 10, 2025 09:38

souvik1914581 requested review from SunnySrivastava1984, PriyangaRamasamy, branupama, jinuthomas and RekhaAparna01 January 10, 2025 09:39

jinuthomas requested changes Jan 13, 2025

View reviewed changes

souvik1914581 force-pushed the sr_vpdToolMfgClean_backupRestoreJson branch from 933e808 to afc67ee Compare January 13, 2025 06:29

souvik1914581 force-pushed the sr_vpdToolMfgClean_backupRestoreJson branch from afc67ee to f62f345 Compare January 13, 2025 06:37

souvik1914581 force-pushed the sr_vpdToolMfgClean_backupRestoreJson branch from f62f345 to aa4c745 Compare January 13, 2025 07:02

souvik1914581 requested a review from jinuthomas January 13, 2025 07:50

jinuthomas requested changes Jan 13, 2025

View reviewed changes

souvik1914581 force-pushed the sr_vpdToolMfgClean_backupRestoreJson branch from aa4c745 to 5583167 Compare January 13, 2025 08:26

souvik1914581 requested a review from jinuthomas January 13, 2025 08:34

jinuthomas requested changes Jan 13, 2025

View reviewed changes

vpd-tool/src/vpd_tool.cpp Show resolved Hide resolved

vpd-tool/src/vpd_tool.cpp Show resolved Hide resolved

souvik1914581 force-pushed the sr_vpdToolMfgClean_backupRestoreJson branch from 5583167 to 2bbb54d Compare January 13, 2025 09:09

jinuthomas approved these changes Jan 13, 2025

View reviewed changes

SunnySrivastava1984 approved these changes Jan 13, 2025

View reviewed changes

SunnySrivastava1984 merged commit aeff541 into ibm-openbmc:1110 Jan 13, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement vpd-tool mfgClean #573

Implement vpd-tool mfgClean #573

souvik1914581 commented Jan 9, 2025

jinuthomas Jan 13, 2025

souvik1914581 Jan 13, 2025

jinuthomas Jan 13, 2025

souvik1914581 Jan 13, 2025

jinuthomas Jan 13, 2025

souvik1914581 Jan 13, 2025

SunnySrivastava1984 Jan 13, 2025

souvik1914581 Jan 13, 2025

jinuthomas Jan 13, 2025

souvik1914581 Jan 13, 2025

jinuthomas Jan 13, 2025

souvik1914581 Jan 13, 2025

jinuthomas Jan 13, 2025 •

edited

Loading

souvik1914581 Jan 13, 2025

jinuthomas Jan 13, 2025

souvik1914581 Jan 13, 2025

jinuthomas Jan 13, 2025 •

edited

Loading

Implement vpd-tool mfgClean #573

Implement vpd-tool mfgClean #573

Conversation

souvik1914581 commented Jan 9, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jinuthomas Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jinuthomas Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

jinuthomas Jan 13, 2025 •

edited

Loading

jinuthomas Jan 13, 2025 •

edited

Loading