14206b1acSJagpal Singh Gilldescription: >
2*921791c7SManojkiran Eda    Interface for performing code update for various firmware entities.
34206b1acSJagpal Singh Gill
44206b1acSJagpal Singh Gillmethods:
54206b1acSJagpal Singh Gill    - name: StartUpdate
64206b1acSJagpal Singh Gill      description: >
7*921791c7SManojkiran Eda          Start a firmware update to be performed asynchronously.
84206b1acSJagpal Singh Gill      parameters:
94206b1acSJagpal Singh Gill          - name: Image
104206b1acSJagpal Singh Gill            type: unixfd
114206b1acSJagpal Singh Gill            description: >
124206b1acSJagpal Singh Gill                This property indicates the file descriptor of the firmware
134206b1acSJagpal Singh Gill                image.
144206b1acSJagpal Singh Gill          - name: ApplyTime
15f0d04c9dSJagpal Singh Gill            type: enum[xyz.openbmc_project.Software.ApplyTime.RequestedApplyTimes]
164206b1acSJagpal Singh Gill            description: >
174206b1acSJagpal Singh Gill                This property indicates when the software image update should be
184206b1acSJagpal Singh Gill                applied.
194206b1acSJagpal Singh Gill      returns:
204206b1acSJagpal Singh Gill          - name: ObjectPath
214206b1acSJagpal Singh Gill            type: object_path
224206b1acSJagpal Singh Gill            description: >
234206b1acSJagpal Singh Gill                The object path where the image interfaces will be hosted, for
244206b1acSJagpal Singh Gill                example, required interfaces such as ActivationStatus,
254206b1acSJagpal Singh Gill                ActivationProgress and optional interfaces such as Version.
264206b1acSJagpal Singh Gill      errors:
274206b1acSJagpal Singh Gill          - xyz.openbmc_project.Software.Update.Error.Incompatible
284206b1acSJagpal Singh Gill          - xyz.openbmc_project.Software.Update.Error.InvalidSignature
294206b1acSJagpal Singh Gill          - xyz.openbmc_project.Software.Update.Error.InvalidImage
304206b1acSJagpal Singh Gill          - xyz.openbmc_project.Common.Error.Unavailable
314206b1acSJagpal Singh Gill
324206b1acSJagpal Singh Gillproperties:
334206b1acSJagpal Singh Gill    - name: AllowedApplyTimes
34f0d04c9dSJagpal Singh Gill      type: set[enum[xyz.openbmc_project.Software.ApplyTime.RequestedApplyTimes]]
354206b1acSJagpal Singh Gill      description: >
364206b1acSJagpal Singh Gill          This property indicates the apply times allowed for this device.
374206b1acSJagpal Singh Gill      flags:
384206b1acSJagpal Singh Gill          - readonly
39