commit f73cb6968165f747b19a6a816abe46d309d30346
author Jagpal Singh Gill <paligill@gmail.com> Mon Jul 08 12:05:03 2024 -0700
committer Jagpal S Gill <paligill@gmail.com> Tue Jul 09 18:29:04 2024 +0000
tree 3a3998c6c4621a7d0d49c694d1726f9ca23e1b6a
parent 5a727b484f69eaea8accb6f066687cc06abc9ad2

code-update: use flat object paths

Rename VersionId to SwId and randomly generate as this happens before
image parsing. Use flat object paths for software as they are easily
mappable from firmware inventory in BMCWeb.

Change-Id: Ia28a565a98dddd843997f9e56e28370372232a55
Signed-off-by: Jagpal Singh Gill <paligill@gmail.com>

designs/code-update.md

diff --git a/designs/code-update.md b/designs/code-update.md
index 8588800..96de1f5 100644
--- a/designs/code-update.md
+++ b/designs/code-update.md
@@ -62,17 +62,16 @@
 
 % Bootstrap Action for CodeUpdater
 note over CU: Get device access info from<br> /xyz/openbmc_project/inventory/system/... path
-note over CU: VersionId = Version Read from <deviceX> + Salt
-CU ->> CU: Create Interface<br> xyz.openbmc_project.Software.Update<br> at /xyz/openbmc_project/Software/<deviceX>/<VersionId>
-CU ->> CU: Create Interface<br> xyz.openbmc_project.Software.Version<br> at /xyz/openbmc_project/Software/<deviceX>/<VersionId>
-CU ->> CU: Create Interface<br>xyz.openbmc_project.Software.Activation<br> at /xyz/openbmc_project/Software/<deviceX>/<VersionId> <br> with Status = Active
+note over CU: Swid = <DeviceX>_<RandomId>
+CU ->> CU: Create Interface<br> xyz.openbmc_project.Software.Update<br> at /xyz/openbmc_project/Software/<SwId>
+CU ->> CU: Create Interface<br> xyz.openbmc_project.Software.Version<br> at /xyz/openbmc_project/Software/<SwId>
+CU ->> CU: Create Interface<br>xyz.openbmc_project.Software.Activation<br> at /xyz/openbmc_project/Software/<SwId> <br> with Status = Active
 CU ->> CU: Create functional association <br> from Version to Inventory Item
 
 CL ->> BMCW: HTTP POST: /redfish/v1/UpdateService/update <br> (Image, settings, RedfishTargetURIArray)
 
 loop For every RedfishTargetURI
-  note over BMCW: Map RedfishTargetURI to<br> System Inventory Item
-  note over BMCW: Get object path (i.e. /xyz/openbmc_project/Software/<deviceX>/<VersionId>)<br>for associated Version interface to System Inventory Item
+  note over BMCW: Map RedfishTargetURI /redfish/v1/UpdateService/FirmwareInventory/<SwId> to<br> Object path /xyz/openbmc_project/software/<SwId>
   note over BMCW: Get serviceName corresponding to the object path <br>from mapper.
   BMCW ->> CU: StartUpdate(Image, ApplyTime)
 
@@ -81,8 +80,8 @@
       CU -->> BMCW: {NULL, Update.Error}
       BMCW -->> CL: Return Error
   end
-  note over CU: VersionId = Version from Image + Salt
-  note over CU: ObjectPath = /xyz/openbmc_project/Software/<deviceX>/<VersionId>
+  note over CU: Swid = <DeviceX>_<RandomId>
+  note over CU: ObjectPath = /xyz/openbmc_project/Software/<SwId>
   CU ->> CU: Create Interface<br> xyz.openbmc_project.Software.Version<br> at ObjectPath
   CU -->> BMCW: {ObjectPath, Success}
   CU ->> CU: << Delegate Update for asynchronous processing >>
@@ -209,7 +208,7 @@
 ### Update multiple devices of same type
 
 - For same type devices, extend the Dbus path to specify device instance, for
-  example, /xyz/openbmc_project/Software/\<deviceX>/\<InstanceNum>/\<VersionId>.
+  example, /xyz/openbmc_project/Software/\<deviceX>\_\<InstanceNum>\_\<SwId>.
   All the corresponding interfaces can reside on this path and same path will be
   returned from xyz.openbmc_project.Software.Update.StartUpdate.