yaml: format with prettier
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I193f690f3612fe72ec69030f81f4d5096a761601
diff --git a/yaml/com/google/gbmc/Hoth.errors.yaml b/yaml/com/google/gbmc/Hoth.errors.yaml
index c697f93..76b4d7a 100644
--- a/yaml/com/google/gbmc/Hoth.errors.yaml
+++ b/yaml/com/google/gbmc/Hoth.errors.yaml
@@ -10,4 +10,3 @@
description: A system error occured with the Hoth interface.
- name: ExpectedInfoNotFound
description: Could not find the expected information in the response.
-
diff --git a/yaml/com/google/gbmc/Hoth.interface.yaml b/yaml/com/google/gbmc/Hoth.interface.yaml
index c15daf5..429f01d 100644
--- a/yaml/com/google/gbmc/Hoth.interface.yaml
+++ b/yaml/com/google/gbmc/Hoth.interface.yaml
@@ -1,294 +1,294 @@
description: >
- Implement the Hoth command control interface.
+ Implement the Hoth command control interface.
methods:
- - name: SendHostCommand
- description: >
- Send a host command to Hoth and return the response.
- This will block on Hoth completing its internal operations.
- Critical host commands like LoadTokens are banned.
- This method should be called from the IPMI HostCommand passthrough.
- parameters:
- - name: Command
- type: array[byte]
- description: >
- Data to write to Hoth SPI host command offset.
- returns:
- - name: Response
- type: array[byte]
- description: >
- Data read from Hoth SPI host command offset.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
- - xyz.openbmc_project.Common.Error.Timeout
+ - name: SendHostCommand
+ description: >
+ Send a host command to Hoth and return the response.
+ This will block on Hoth completing its internal operations.
+ Critical host commands like LoadTokens are banned.
+ This method should be called from the IPMI HostCommand passthrough.
+ parameters:
+ - name: Command
+ type: array[byte]
+ description: >
+ Data to write to Hoth SPI host command offset.
+ returns:
+ - name: Response
+ type: array[byte]
+ description: >
+ Data read from Hoth SPI host command offset.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
+ - xyz.openbmc_project.Common.Error.Timeout
- - name: SendTrustedHostCommand
- description: >
- Send a host command to Hoth and return the response.
- This will block on Hoth completing its internal operations.
- Critical host commands like LoadTokens are allowed.
- This method should be called from the BMC.
- parameters:
- - name: Command
- type: array[byte]
- description: >
- Data to write to Hoth SPI host command offset.
- returns:
- - name: Response
- type: array[byte]
- description: >
- Data read from Hoth SPI host command offset.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
- - xyz.openbmc_project.Common.Error.Timeout
+ - name: SendTrustedHostCommand
+ description: >
+ Send a host command to Hoth and return the response.
+ This will block on Hoth completing its internal operations.
+ Critical host commands like LoadTokens are allowed.
+ This method should be called from the BMC.
+ parameters:
+ - name: Command
+ type: array[byte]
+ description: >
+ Data to write to Hoth SPI host command offset.
+ returns:
+ - name: Response
+ type: array[byte]
+ description: >
+ Data read from Hoth SPI host command offset.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
+ - xyz.openbmc_project.Common.Error.Timeout
- - name: SendHostCommandAsync
- description: >
- Send a host command to Hoth and immediately return without waiting for
- response. Caller can either poll with calls to GetHostCommandResponse
- until retrieving the response, or wait for a ResponseReady signal.
- parameters:
- - name: Command
- type: array[byte]
- description: >
- Data to write to Hoth SPI host command offset.
- returns:
- - name: CallToken
- type: uint64
- description: >
- The representation for the call made
- errors:
- - self.Error.CommandFailure
+ - name: SendHostCommandAsync
+ description: >
+ Send a host command to Hoth and immediately return without waiting for
+ response. Caller can either poll with calls to GetHostCommandResponse
+ until retrieving the response, or wait for a ResponseReady signal.
+ parameters:
+ - name: Command
+ type: array[byte]
+ description: >
+ Data to write to Hoth SPI host command offset.
+ returns:
+ - name: CallToken
+ type: uint64
+ description: >
+ The representation for the call made
+ errors:
+ - self.Error.CommandFailure
- - name: GetHostCommandResponse
- description: >
- Read the response from Hoth mailbox.
- parameters:
- - name: CallToken
- type: uint64
- description: >
- The token returned from SendHostCommandAsync()
- returns:
- - name: Response
- type: array[byte]
- description: >
- Data read from Hoth SPI host command offset
- errors:
- - self.Error.ResponseFailure
- - self.Error.ResponseNotFound
- - self.Error.InterfaceError
+ - name: GetHostCommandResponse
+ description: >
+ Read the response from Hoth mailbox.
+ parameters:
+ - name: CallToken
+ type: uint64
+ description: >
+ The token returned from SendHostCommandAsync()
+ returns:
+ - name: Response
+ type: array[byte]
+ description: >
+ Data read from Hoth SPI host command offset
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ResponseNotFound
+ - self.Error.InterfaceError
- - name: UpdateFirmware
- description: >
- Write given firmware data to the Hoth firmware partition in EEPROM.
- parameters:
- - name: FirmwareData
- type: array[byte]
- description: >
- Hoth firmware image
- errors:
- - self.Error.FirmwareFailure
+ - name: UpdateFirmware
+ description: >
+ Write given firmware data to the Hoth firmware partition in EEPROM.
+ parameters:
+ - name: FirmwareData
+ type: array[byte]
+ description: >
+ Hoth firmware image
+ errors:
+ - self.Error.FirmwareFailure
- - name: GetFirmwareUpdateStatus
- description: >
- Get the status of the firmware update process.
- returns:
- - name: Status
- type: enum[self.FirmwareUpdateStatus]
- description: >
- Status of the firmware update
+ - name: GetFirmwareUpdateStatus
+ description: >
+ Get the status of the firmware update process.
+ returns:
+ - name: Status
+ type: enum[self.FirmwareUpdateStatus]
+ description: >
+ Status of the firmware update
- - name: InitiatePayload
- description: >
- Initiates erasure of the EEPROM staging area. Note that this will lock up
- access to Hoth for an extended time and may go over the kernel's SPI
- write timeout. Calling multiple small ErasePayload is recommended.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: InitiatePayload
+ description: >
+ Initiates erasure of the EEPROM staging area. Note that this will lock up
+ access to Hoth for an extended time and may go over the kernel's SPI
+ write timeout. Calling multiple small ErasePayload is recommended.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: GetInitiatePayloadStatus
- description: >
- Get the status of the payload initiation process.
- returns:
- - name: Status
- type: enum[self.FirmwareUpdateStatus]
- description: >
- Status of the payload initiation
+ - name: GetInitiatePayloadStatus
+ description: >
+ Get the status of the payload initiation process.
+ returns:
+ - name: Status
+ type: enum[self.FirmwareUpdateStatus]
+ description: >
+ Status of the payload initiation
- - name: ErasePayload
- description: >
- Erases the given size starting at the specified offset of the staging
- partition.
- parameters:
- - name: Offset
- type: uint32
- description: >
- Offset of the staging partition to start erasing from.
- - name: Size
- type: uint32
- description: >
- Size of the staging partition to erase.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: ErasePayload
+ description: >
+ Erases the given size starting at the specified offset of the staging
+ partition.
+ parameters:
+ - name: Offset
+ type: uint32
+ description: >
+ Offset of the staging partition to start erasing from.
+ - name: Size
+ type: uint32
+ description: >
+ Size of the staging partition to erase.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: SendPayload
- description: >
- Chunk and send the binary specified in the image path
- parameters:
- - name: ImagePath
- type: string
- description: >
- Firmware image path
- errors:
- - self.Error.FirmwareFailure
- - self.Error.InterfaceError
+ - name: SendPayload
+ description: >
+ Chunk and send the binary specified in the image path
+ parameters:
+ - name: ImagePath
+ type: string
+ description: >
+ Firmware image path
+ errors:
+ - self.Error.FirmwareFailure
+ - self.Error.InterfaceError
- - name: GetSendPayloadStatus
- description: >
- Get the status of the send payload process.
- returns:
- - name: Status
- type: enum[self.FirmwareUpdateStatus]
- description: >
- Status of the send payload process.
+ - name: GetSendPayloadStatus
+ description: >
+ Get the status of the send payload process.
+ returns:
+ - name: Status
+ type: enum[self.FirmwareUpdateStatus]
+ description: >
+ Status of the send payload process.
- - name: VerifyPayload
- description: >
- Initiates the verification process without activating the staging area
- errors:
- - self.Error.InterfaceError
+ - name: VerifyPayload
+ description: >
+ Initiates the verification process without activating the staging area
+ errors:
+ - self.Error.InterfaceError
- - name: GetVerifyPayloadStatus
- description: >
- Get the status of the payload verification process.
- returns:
- - name: Status
- type: enum[self.FirmwareUpdateStatus]
- description: >
- Status of the payload verification
+ - name: GetVerifyPayloadStatus
+ description: >
+ Get the status of the payload verification process.
+ returns:
+ - name: Status
+ type: enum[self.FirmwareUpdateStatus]
+ description: >
+ Status of the payload verification
- - name: ActivatePayload
- description: >
- Activates the staging area as persistent or non-persistent for next boot
- if verification was successful.
- parameters:
- - name: MakePersistent
- type: boolean
- description: >
- Flag to determine whether to activate the staged image as persistent
- or non-persistent for next boot.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: ActivatePayload
+ description: >
+ Activates the staging area as persistent or non-persistent for next boot
+ if verification was successful.
+ parameters:
+ - name: MakePersistent
+ type: boolean
+ description: >
+ Flag to determine whether to activate the staged image as persistent
+ or non-persistent for next boot.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: GetPayloadSize
- description: >
- Determines the max size of the payload region.
- returns:
- - name: Size
- type: uint32
- description: >
- The size of the payload region
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: GetPayloadSize
+ description: >
+ Determines the max size of the payload region.
+ returns:
+ - name: Size
+ type: uint32
+ description: >
+ The size of the payload region
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: Confirm
- description: >
- Prevents hoth from rolling back and using the previous image.
- When an image can be comfirmed to be working well, this command is given,
- which disarms the hoth watchdog.
- errors:
- - self.Error.CommandFailure
- - self.Error.ResponseFailure
- - self.Error.InterfaceError
+ - name: Confirm
+ description: >
+ Prevents hoth from rolling back and using the previous image.
+ When an image can be comfirmed to be working well, this command is given,
+ which disarms the hoth watchdog.
+ errors:
+ - self.Error.CommandFailure
+ - self.Error.ResponseFailure
+ - self.Error.InterfaceError
- - name: GetTotalBootTime
- description: >
- Get total time spending from reset to HVNGOOD.
- returns:
- - name: Time
- type: uint32
- description: >
- Time in microseconds.
- errors:
- - self.Error.ResponseFailure
- - self.Error.ExpectedInfoNotFound
+ - name: GetTotalBootTime
+ description: >
+ Get total time spending from reset to HVNGOOD.
+ returns:
+ - name: Time
+ type: uint32
+ description: >
+ Time in microseconds.
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ExpectedInfoNotFound
- - name: GetFirmwareUpdateTime
- description: >
- Get time spending in the self update routine. Since a proper self update
- involves a reset, this time is always expected to be low.
- returns:
- - name: Time
- type: uint32
- description: >
- Time in microseconds.
- errors:
- - self.Error.ResponseFailure
- - self.Error.ExpectedInfoNotFound
+ - name: GetFirmwareUpdateTime
+ description: >
+ Get time spending in the self update routine. Since a proper self update
+ involves a reset, this time is always expected to be low.
+ returns:
+ - name: Time
+ type: uint32
+ description: >
+ Time in microseconds.
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ExpectedInfoNotFound
- - name: GetFirmwareMirroringTime
- description: >
- Get time spending in mirroing the self-update. This time is a reasonable
- proxy for the total self update time.
- returns:
- - name: Time
- type: uint32
- description: >
- Time in microseconds.
- errors:
- - self.Error.ResponseFailure
- - self.Error.ExpectedInfoNotFound
+ - name: GetFirmwareMirroringTime
+ description: >
+ Get time spending in mirroing the self-update. This time is a reasonable
+ proxy for the total self update time.
+ returns:
+ - name: Time
+ type: uint32
+ description: >
+ Time in microseconds.
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ExpectedInfoNotFound
- - name: GetPayloadValidationTime
- description: >
- Get time spending in validating the payload, copying mutable regions and/or
- dealing with failsafe fallback.
- returns:
- - name: Time
- type: uint32
- description: >
- Time in microseconds.
- errors:
- - self.Error.ResponseFailure
- - self.Error.ExpectedInfoNotFound
+ - name: GetPayloadValidationTime
+ description: >
+ Get time spending in validating the payload, copying mutable regions and/or
+ dealing with failsafe fallback.
+ returns:
+ - name: Time
+ type: uint32
+ description: >
+ Time in microseconds.
+ errors:
+ - self.Error.ResponseFailure
+ - self.Error.ExpectedInfoNotFound
signals:
- - name: HostCommandResponseReady
- description: >
- This signal is broadcast when a response is ready for the call that
- returned CallToken.
- properties:
- - name: CallToken
- type: uint64
- description: >
- The token returned from SendHostCommandAsync()
+ - name: HostCommandResponseReady
+ description: >
+ This signal is broadcast when a response is ready for the call that
+ returned CallToken.
+ properties:
+ - name: CallToken
+ type: uint64
+ description: >
+ The token returned from SendHostCommandAsync()
enumerations:
- - name: FirmwareUpdateStatus
- description: >
- The status of a firmware update through hothd
- values:
- - name: 'None'
- description: >
- No update initiated
- - name: 'InProgress'
- description: >
- Update still in progress
- - name: 'Error'
- description: >
- Update has failed
- - name: 'Done'
- description: >
- Update has completed successfully
+ - name: FirmwareUpdateStatus
+ description: >
+ The status of a firmware update through hothd
+ values:
+ - name: "None"
+ description: >
+ No update initiated
+ - name: "InProgress"
+ description: >
+ Update still in progress
+ - name: "Error"
+ description: >
+ Update has failed
+ - name: "Done"
+ description: >
+ Update has completed successfully
diff --git a/yaml/com/ibm/Dump/Create.interface.yaml b/yaml/com/ibm/Dump/Create.interface.yaml
index c5cf772..847b64a 100644
--- a/yaml/com/ibm/Dump/Create.interface.yaml
+++ b/yaml/com/ibm/Dump/Create.interface.yaml
@@ -8,36 +8,36 @@
description: >
Additional parameters for creating the dump.
values:
- - name: 'VSPString'
- description: >
- The resouce dump is collected from various host resources.
- The resource to collect the dump is indicated by using the
- resource selector.
- The resource selector string needs to be passed to host to
- generate a resource dump.
- - name: 'Password'
- description: >
- The password for authenticating the resource dump request.
- - name: 'ErrorLogId'
- description: >
- The id of the log associated with action which triggered the
- dump. The value should be a 32 bit unsigned integer.
- - name: 'DumpType'
- description: >
- Type of the dump to be collected
- - name: 'FailingUnitId'
- description: >
- A unique id of failing hardware unit which is causing the dump.
- The value should be a 32 bit unsigned integer.
+ - name: "VSPString"
+ description: >
+ The resouce dump is collected from various host resources.
+ The resource to collect the dump is indicated by using the
+ resource selector.
+ The resource selector string needs to be passed to host to
+ generate a resource dump.
+ - name: "Password"
+ description: >
+ The password for authenticating the resource dump request.
+ - name: "ErrorLogId"
+ description: >
+ The id of the log associated with action which triggered the
+ dump. The value should be a 32 bit unsigned integer.
+ - name: "DumpType"
+ description: >
+ Type of the dump to be collected
+ - name: "FailingUnitId"
+ description: >
+ A unique id of failing hardware unit which is causing the dump.
+ The value should be a 32 bit unsigned integer.
- name: DumpType
description: >
Type of the host dump to be collected.
values:
- - name: 'Hostboot'
- description: >
- Hostboot dump is collected during a boot failure during the
- hostboot booting phase.
- - name: 'Hardware'
- desription: >
- Hardware dump is collected during a system checkstop.
+ - name: "Hostboot"
+ description: >
+ Hostboot dump is collected during a boot failure during the
+ hostboot booting phase.
+ - name: "Hardware"
+ desription: >
+ Hardware dump is collected during a system checkstop.
diff --git a/yaml/com/ibm/Dump/Entry/Resource.interface.yaml b/yaml/com/ibm/Dump/Entry/Resource.interface.yaml
index da5332f..17a38d9 100644
--- a/yaml/com/ibm/Dump/Entry/Resource.interface.yaml
+++ b/yaml/com/ibm/Dump/Entry/Resource.interface.yaml
@@ -23,4 +23,3 @@
type: string
description: >
The password required by host to validate the request.
-
diff --git a/yaml/com/ibm/Logging/Policy.interface.yaml b/yaml/com/ibm/Logging/Policy.interface.yaml
index de83d86..2dc6d05 100644
--- a/yaml/com/ibm/Logging/Policy.interface.yaml
+++ b/yaml/com/ibm/Logging/Policy.interface.yaml
@@ -1,5 +1,5 @@
description: >
- Implement to provide IBM specific error log policy attributes.
+ Implement to provide IBM specific error log policy attributes.
properties:
- name: EventID
type: string
diff --git a/yaml/com/ibm/VPD.errors.yaml b/yaml/com/ibm/VPD.errors.yaml
index ee4b735..a69e8c1 100644
--- a/yaml/com/ibm/VPD.errors.yaml
+++ b/yaml/com/ibm/VPD.errors.yaml
@@ -10,15 +10,15 @@
description: Keyword is not found.
- name: BlankSystemVPD
description: System VPD is blank on both hardware and cache.
- On IBM systems, certain VPD data must be available
- for the system to boot. This error is used to
- indicate that no valid data was found by the BMC.
+ On IBM systems, certain VPD data must be available
+ for the system to boot. This error is used to
+ indicate that no valid data was found by the BMC.
- name: InvalidEepromPath
description: EEPROM path is invalid. Parser failed to access the
- path.
+ path.
- name: InvalidVPD
description: VPD file is not valid. Mandatory records are missing
- in VPD file.
+ in VPD file.
- name: EccCheckFailed
desciption: Invalid VPD data. Ecc check for the data failed.
- name: InvalidJson
diff --git a/yaml/com/ibm/VPD/Manager.interface.yaml b/yaml/com/ibm/VPD/Manager.interface.yaml
index 179283a..ddeacd4 100644
--- a/yaml/com/ibm/VPD/Manager.interface.yaml
+++ b/yaml/com/ibm/VPD/Manager.interface.yaml
@@ -5,72 +5,72 @@
description: >
A method to update the keyword value for a given VPD record.
parameters:
- - name: path
- type: path
- description: >
- Path to the D-Bus object that represents the FRU.
- - name: record
- type: string
- description: >
- Record whose keyword value needs to be modified.
- - name: keyword
- type: string
- description: >
- Keyword whose value needs to be updated.
- - name: value
- type: array[byte]
- description: >
- Value to be updated for the keyword.
+ - name: path
+ type: path
+ description: >
+ Path to the D-Bus object that represents the FRU.
+ - name: record
+ type: string
+ description: >
+ Record whose keyword value needs to be modified.
+ - name: keyword
+ type: string
+ description: >
+ Keyword whose value needs to be updated.
+ - name: value
+ type: array[byte]
+ description: >
+ Value to be updated for the keyword.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - com.ibm.VPD.Error.PathNotFound
- - com.ibm.VPD.Error.RecordNotFound
- - com.ibm.VPD.Error.KeywordNotFound
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - com.ibm.VPD.Error.PathNotFound
+ - com.ibm.VPD.Error.RecordNotFound
+ - com.ibm.VPD.Error.KeywordNotFound
- name: GetFRUsByUnexpandedLocationCode
description: >
A method to get list of FRU D-BUS object paths for a given
unexpanded location code.
parameters:
- - name: locationCode
- type: string
- description: >
- An un-expanded Location code.
- - name: nodeNumber
- type: uint16
- description: >
- Denotes the node in case of a multi-node configuration,
- ignored on a single node system.
+ - name: locationCode
+ type: string
+ description: >
+ An un-expanded Location code.
+ - name: nodeNumber
+ type: uint16
+ description: >
+ Denotes the node in case of a multi-node configuration,
+ ignored on a single node system.
returns:
- - name: inventoryList
- type: array[path]
- description: >
- List of all the FRUs D-Bus object paths for the given location
- code.
+ - name: inventoryList
+ type: array[path]
+ description: >
+ List of all the FRUs D-Bus object paths for the given location
+ code.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - com.ibm.VPD.Error.LocationNotFound
- - com.ibm.VPD.Error.NodeNotFound
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - com.ibm.VPD.Error.LocationNotFound
+ - com.ibm.VPD.Error.NodeNotFound
- name: GetFRUsByExpandedLocationCode
description: >
A method to get list of FRU D-BUS object paths for a given expanded
location code.
parameters:
- - name: locationCode
- type: string
- description: >
- Location code in expanded format.
+ - name: locationCode
+ type: string
+ description: >
+ Location code in expanded format.
returns:
- - name: inventoryList
- type: array[path]
- description: >
- List of all the FRUs D-Bus object path for the given location
- code.
+ - name: inventoryList
+ type: array[path]
+ description: >
+ List of all the FRUs D-Bus object path for the given location
+ code.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - com.ibm.VPD.Error.LocationNotFound
- - com.ibm.VPD.Error.NodeNotFound
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - com.ibm.VPD.Error.LocationNotFound
+ - com.ibm.VPD.Error.NodeNotFound
- name: GetExpandedLocationCode
description: >
@@ -78,28 +78,28 @@
un-expanded location code.
Expanded location codes gives the location of the FRU in the system.
parameters:
- - name: locationCode
- type: string
- description: >
- Location code in un-expanded format.
- - name: nodeNumber
- type: uint16
- description: >
- Denotes the node in case of multi-node configuration.
- Ignored in case of single node configuration.
+ - name: locationCode
+ type: string
+ description: >
+ Location code in un-expanded format.
+ - name: nodeNumber
+ type: uint16
+ description: >
+ Denotes the node in case of multi-node configuration.
+ Ignored in case of single node configuration.
returns:
- - name: locationCode
- type: string
- description: >
- Location code in expanded format.
+ - name: locationCode
+ type: string
+ description: >
+ Location code in expanded format.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - com.ibm.VPD.Error.LocationNotFound
- - com.ibm.VPD.Error.NodeNotFound
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - com.ibm.VPD.Error.LocationNotFound
+ - com.ibm.VPD.Error.NodeNotFound
- name: PerformVPDRecollection
description: >
An api to check for FRUs replaced and if required, perform
recollection of VPD data for them.
errors:
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InvalidArgument
diff --git a/yaml/com/ibm/ipzvpd/CP00.interface.yaml b/yaml/com/ibm/ipzvpd/CP00.interface.yaml
index 0ec995b..bbc5652 100644
--- a/yaml/com/ibm/ipzvpd/CP00.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/CP00.interface.yaml
@@ -50,4 +50,3 @@
type: array[byte]
description: >
D5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/DINF.interface.yaml b/yaml/com/ibm/ipzvpd/DINF.interface.yaml
index 619ae15..db19377 100644
--- a/yaml/com/ibm/ipzvpd/DINF.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/DINF.interface.yaml
@@ -13,4 +13,3 @@
type: array[byte]
description: >
FL keyword. The FRU label.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP0.interface.yaml b/yaml/com/ibm/ipzvpd/LRP0.interface.yaml
index cd2f360..efcd913 100644
--- a/yaml/com/ibm/ipzvpd/LRP0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP0.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP1.interface.yaml b/yaml/com/ibm/ipzvpd/LRP1.interface.yaml
index e02320b..63f2650 100644
--- a/yaml/com/ibm/ipzvpd/LRP1.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP1.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP2.interface.yaml b/yaml/com/ibm/ipzvpd/LRP2.interface.yaml
index 9657386..e4818c2 100644
--- a/yaml/com/ibm/ipzvpd/LRP2.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP2.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP3.interface.yaml b/yaml/com/ibm/ipzvpd/LRP3.interface.yaml
index d8ce8d2..8889788 100644
--- a/yaml/com/ibm/ipzvpd/LRP3.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP3.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP4.interface.yaml b/yaml/com/ibm/ipzvpd/LRP4.interface.yaml
index 69d0799..371eca5 100644
--- a/yaml/com/ibm/ipzvpd/LRP4.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP4.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP5.interface.yaml b/yaml/com/ibm/ipzvpd/LRP5.interface.yaml
index 8d369dd..a883ecf 100644
--- a/yaml/com/ibm/ipzvpd/LRP5.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP5.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP6.interface.yaml b/yaml/com/ibm/ipzvpd/LRP6.interface.yaml
index 2ba871b..ede98ac 100644
--- a/yaml/com/ibm/ipzvpd/LRP6.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP6.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LRP7.interface.yaml b/yaml/com/ibm/ipzvpd/LRP7.interface.yaml
index b9e3921..60b4a5b 100644
--- a/yaml/com/ibm/ipzvpd/LRP7.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LRP7.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
D4 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP0.interface.yaml b/yaml/com/ibm/ipzvpd/LWP0.interface.yaml
index 9fc846e..6f940e0 100644
--- a/yaml/com/ibm/ipzvpd/LWP0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP0.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP1.interface.yaml b/yaml/com/ibm/ipzvpd/LWP1.interface.yaml
index 784820f..61684fc 100644
--- a/yaml/com/ibm/ipzvpd/LWP1.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP1.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP2.interface.yaml b/yaml/com/ibm/ipzvpd/LWP2.interface.yaml
index 9a43d9b..370e4c4 100644
--- a/yaml/com/ibm/ipzvpd/LWP2.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP2.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP3.interface.yaml b/yaml/com/ibm/ipzvpd/LWP3.interface.yaml
index 1b2f6e4..45d249e 100644
--- a/yaml/com/ibm/ipzvpd/LWP3.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP3.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP4.interface.yaml b/yaml/com/ibm/ipzvpd/LWP4.interface.yaml
index 972a392..1be2dfb 100644
--- a/yaml/com/ibm/ipzvpd/LWP4.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP4.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP5.interface.yaml b/yaml/com/ibm/ipzvpd/LWP5.interface.yaml
index 717ae05..5021565 100644
--- a/yaml/com/ibm/ipzvpd/LWP5.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP5.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP6.interface.yaml b/yaml/com/ibm/ipzvpd/LWP6.interface.yaml
index dbb7f9c..e45f3b3 100644
--- a/yaml/com/ibm/ipzvpd/LWP6.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP6.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LWP7.interface.yaml b/yaml/com/ibm/ipzvpd/LWP7.interface.yaml
index db456f1..4b88827 100644
--- a/yaml/com/ibm/ipzvpd/LWP7.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LWP7.interface.yaml
@@ -49,4 +49,3 @@
type: array[byte]
description: >
F5 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/LXR0.interface.yaml b/yaml/com/ibm/ipzvpd/LXR0.interface.yaml
index d1409ec..ac3d3cc 100644
--- a/yaml/com/ibm/ipzvpd/LXR0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/LXR0.interface.yaml
@@ -13,4 +13,3 @@
type: array[byte]
description: >
LX keyword. The load ID data.
-
diff --git a/yaml/com/ibm/ipzvpd/Location.interface.yaml b/yaml/com/ibm/ipzvpd/Location.interface.yaml
index b5a83a7..c64e7a8 100644
--- a/yaml/com/ibm/ipzvpd/Location.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/Location.interface.yaml
@@ -6,4 +6,3 @@
description: >
A string describing the physical location of the FRU.
The location is determined based on the system design.
-
diff --git a/yaml/com/ibm/ipzvpd/MER0.interface.yaml b/yaml/com/ibm/ipzvpd/MER0.interface.yaml
index 67d3797..f9e472b 100644
--- a/yaml/com/ibm/ipzvpd/MER0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/MER0.interface.yaml
@@ -10,4 +10,3 @@
type: array[byte]
description: >
The "#I" keyword. Contains the repair data.
-
diff --git a/yaml/com/ibm/ipzvpd/UTIL.interface.yaml b/yaml/com/ibm/ipzvpd/UTIL.interface.yaml
index 31b655d..a51c747 100644
--- a/yaml/com/ibm/ipzvpd/UTIL.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/UTIL.interface.yaml
@@ -86,4 +86,3 @@
type: array[byte]
description: >
F9 keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/VCEN.interface.yaml b/yaml/com/ibm/ipzvpd/VCEN.interface.yaml
index 9a412c2..97ab017 100644
--- a/yaml/com/ibm/ipzvpd/VCEN.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VCEN.interface.yaml
@@ -29,4 +29,3 @@
type: array[byte]
description: >
RB keyword. Brand specific data.
-
diff --git a/yaml/com/ibm/ipzvpd/VCFG.interface.yaml b/yaml/com/ibm/ipzvpd/VCFG.interface.yaml
index 5021fe6..1e19926 100644
--- a/yaml/com/ibm/ipzvpd/VCFG.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VCFG.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
Second base MAC address.
-
diff --git a/yaml/com/ibm/ipzvpd/VEIR.interface.yaml b/yaml/com/ibm/ipzvpd/VEIR.interface.yaml
index 115ccdd..28843f5 100644
--- a/yaml/com/ibm/ipzvpd/VEIR.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VEIR.interface.yaml
@@ -10,4 +10,3 @@
type: array[byte]
description: >
The "#I" keyword. Contains the repair data.
-
diff --git a/yaml/com/ibm/ipzvpd/VER0.interface.yaml b/yaml/com/ibm/ipzvpd/VER0.interface.yaml
index d5869e9..1c0d3c8 100644
--- a/yaml/com/ibm/ipzvpd/VER0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VER0.interface.yaml
@@ -10,4 +10,3 @@
type: array[byte]
description: >
The "#I" keyword. Contains the repair data.
-
diff --git a/yaml/com/ibm/ipzvpd/VMPU.interface.yaml b/yaml/com/ibm/ipzvpd/VMPU.interface.yaml
index fb14fd0..97ebf97 100644
--- a/yaml/com/ibm/ipzvpd/VMPU.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VMPU.interface.yaml
@@ -21,4 +21,3 @@
type: array[byte]
description: >
IN Keyword. Multi purpose usage data.
-
diff --git a/yaml/com/ibm/ipzvpd/VMSC.interface.yaml b/yaml/com/ibm/ipzvpd/VMSC.interface.yaml
index 04865f9..4e19656 100644
--- a/yaml/com/ibm/ipzvpd/VMSC.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VMSC.interface.yaml
@@ -9,4 +9,3 @@
type: array[byte]
description: >
IN keyword. Multi purpose usage data.
-
diff --git a/yaml/com/ibm/ipzvpd/VPRI.interface.yaml b/yaml/com/ibm/ipzvpd/VPRI.interface.yaml
index 21fbfc6..f5360d9 100644
--- a/yaml/com/ibm/ipzvpd/VPRI.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VPRI.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
'#D' keyword. Card specific data.
-
diff --git a/yaml/com/ibm/ipzvpd/VR10.interface.yaml b/yaml/com/ibm/ipzvpd/VR10.interface.yaml
index fdde378..ae2d879 100644
--- a/yaml/com/ibm/ipzvpd/VR10.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VR10.interface.yaml
@@ -21,4 +21,3 @@
type: array[byte]
description: >
WA keyword.
-
diff --git a/yaml/com/ibm/ipzvpd/VRTN.interface.yaml b/yaml/com/ibm/ipzvpd/VRTN.interface.yaml
index 005e224..4bf56fe 100644
--- a/yaml/com/ibm/ipzvpd/VRTN.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VRTN.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
I2 keyword. Multi purpose data.
-
diff --git a/yaml/com/ibm/ipzvpd/VSBP.interface.yaml b/yaml/com/ibm/ipzvpd/VSBP.interface.yaml
index c7487ca..1f81914 100644
--- a/yaml/com/ibm/ipzvpd/VSBP.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VSBP.interface.yaml
@@ -17,4 +17,3 @@
type: array[byte]
description: >
A unique keyword to identify the system.
-
diff --git a/yaml/com/ibm/ipzvpd/VSRC.interface.yaml b/yaml/com/ibm/ipzvpd/VSRC.interface.yaml
index cb0d46b..6a5bb97 100644
--- a/yaml/com/ibm/ipzvpd/VSRC.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VSRC.interface.yaml
@@ -13,4 +13,3 @@
type: array[byte]
description: >
IN keyword. FRU plug history data.
-
diff --git a/yaml/com/ibm/ipzvpd/VSYS.interface.yaml b/yaml/com/ibm/ipzvpd/VSYS.interface.yaml
index 83b22ff..b15a0a8 100644
--- a/yaml/com/ibm/ipzvpd/VSYS.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VSYS.interface.yaml
@@ -61,4 +61,3 @@
type: array[byte]
description: >
Firmware version.
-
diff --git a/yaml/com/ibm/ipzvpd/VW10.interface.yaml b/yaml/com/ibm/ipzvpd/VW10.interface.yaml
index fe165ac..aac4aed 100644
--- a/yaml/com/ibm/ipzvpd/VW10.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VW10.interface.yaml
@@ -13,4 +13,3 @@
type: array[byte]
description: >
Gard data.
-
diff --git a/yaml/com/intel/Protocol/PECI/Raw.interface.yaml b/yaml/com/intel/Protocol/PECI/Raw.interface.yaml
index 9b8d071..f2fdb34 100644
--- a/yaml/com/intel/Protocol/PECI/Raw.interface.yaml
+++ b/yaml/com/intel/Protocol/PECI/Raw.interface.yaml
@@ -6,20 +6,20 @@
description: >
Send raw PECI command(s) to the CPU
parameters:
- - name: device
- type: string
- description: >
- The path for the PECI device to use for the command
- - name: commands
- type: array[array[byte]]
- description: >
- An array of byte arrays where each byte array holds the raw
- bytes for a single PECI command. The larger array allows
- sending multiple PECI commands in a single transaction.
+ - name: device
+ type: string
+ description: >
+ The path for the PECI device to use for the command
+ - name: commands
+ type: array[array[byte]]
+ description: >
+ An array of byte arrays where each byte array holds the raw
+ bytes for a single PECI command. The larger array allows
+ sending multiple PECI commands in a single transaction.
returns:
- - name: results
- type: array[array[byte]]
- description: >
- An array of byte arrays where each byte array holds the raw
- bytes for a single PECI response corresponding to the command
- in the command array.
+ - name: results
+ type: array[array[byte]]
+ description: >
+ An array of byte arrays where each byte array holds the raw
+ bytes for a single PECI response corresponding to the command
+ in the command array.