NIC: Add new NIC dump entry interface

NIC is a new type of dump in openbmc/phosphor-debug-collector.

Change-Id: Ie9ae8fa754d3b5d57b1e008394491fa1ef80012e
Signed-off-by: eddylu <puzzy8338@gmail.com>

Fix spelling mistakes using codespell

This commit corrects various spelling mistakes throughout the
repository. The corrections were made automatically using `codespell`[1]
tool.

[1]: https://githu

Fix spelling mistakes using codespell

This commit corrects various spelling mistakes throughout the
repository. The corrections were made automatically using `codespell`[1]
tool.

[1]: https://github.com/codespell-project/codespell

Change-Id: I965f52f9eae78bcad39a8d711f99bef7be4cbde0
Signed-off-by: Manojkiran Eda <manojkiran.eda@gmail.com>

show more ...

Add response code to system dump entry

Add new property in the system dump entry for storing the
response code returned by the host after requesting a new
non-disruptive system dump.

Change-Id: Ie

Add response code to system dump entry

Add new property in the system dump entry for storing the
response code returned by the host after requesting a new
non-disruptive system dump.

Change-Id: Ie6d8204ee6d7574fece9c8fc530bf28b09e50e63
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Dump.Create: Add system dump path

Update paths to include SYSTEM segment too, which is needed
for xyz.openbmc_project.Dump.Entry.System interface

Change-Id: I7ca769871c9cdc5ce7c4d4b80187f447bb169cb

Dump.Create: Add system dump path

Update paths to include SYSTEM segment too, which is needed
for xyz.openbmc_project.Dump.Entry.System interface

Change-Id: I7ca769871c9cdc5ce7c4d4b80187f447bb169cb6
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Dump.Entry.FaultLog: interface restructure

Moved Dump.Entry.FaultLog.FaultDataType enum definition to
common folder. This to to use FaultDataType enums in different
interfaces.

Tested: Build verifi

Dump.Entry.FaultLog: interface restructure

Moved Dump.Entry.FaultLog.FaultDataType enum definition to
common folder. This to to use FaultDataType enums in different
interfaces.

Tested: Build verified.

Change-Id: I1073ab5e558fc5444a4164492ebb36682dc51e8d
Signed-off-by: Jayanth Othayoth <ojayanth@gmail.com>

show more ...

Dump.Create.CreateParameters: Fix documentation typo

Change-Id: I0f18f881afc09f0d1e76b5ccec1cf21c33902601
Signed-off-by: Jayanth Othayoth <ojayanth@gmail.com>

Dump.Create: add default path and service names

Add default service name for the phosphor-debug-collector
implementation and paths for the dump namespace.

Signed-off-by: Patrick Williams <patrick@s

Dump.Create: add default path and service names

Add default service name for the phosphor-debug-collector
implementation and paths for the dump namespace.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I30714dbe9f91e0bbff53b0fa45086ec871421d63

show more ...

Dump: Add user-challenge to System Dump entry

This commit introduces a 'UserChallenge' field to the
xyz.openbmc_project.Dump.Entry.System interface. This update
specifically addresses the requiremen

Dump: Add user-challenge to System Dump entry

This commit introduces a 'UserChallenge' field to the
xyz.openbmc_project.Dump.Entry.System interface. This update
specifically addresses the requirement for non-disruptive system dumps.
Non-disruptive dumps are requested to the host and do not disrupt the
current system state. However, as they consume significant host
resources and involve the collection of host memory data, they must be
executed by authorized personnel.

To enforce this, the host requires user-challenge validation to process
the dump request. If the provided user-challenge is incorrect, the host
rejects the operation.

Change-Id: Ia9871a7264e036715a3ebe10f9054a2302e64c32
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Dump: Add 'SystemImpact' to System Dump entry

This commit introduces 'SystemImpact' to the system dump
entry. This new enum field indicates whether a system
dump is 'Disruptive' or 'NonDisruptive'.

Dump: Add 'SystemImpact' to System Dump entry

This commit introduces 'SystemImpact' to the system dump
entry. This new enum field indicates whether a system
dump is 'Disruptive' or 'NonDisruptive'.

'Disruptive' dumps alter the system state and capture
extensive data, making them useful for diagnosing system
crashes. In contrast, 'NonDisruptive' dumps do not
disturb the system state while still providing valuable
data for analysis.

Change-Id: I03810e86e1db9d2b46891dbe2e00e436e76b2cc2
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Dump: Add token to host dump entries

This commit introduces a token field to the
xyz.openbmc_project.Dump.Entry.System and
com.ibm.Dump.Entry.Resource interfaces. This token is
exchanged from the ho

Dump: Add token to host dump entries

This commit introduces a token field to the
xyz.openbmc_project.Dump.Entry.System and
com.ibm.Dump.Entry.Resource interfaces. This token is
exchanged from the host when a request to create a dump
is made. The token can be used to identify the dump
entry once the collection is completed. This addition
enhances the tracking of dump entries for the dumps
collected in the host.

Change-Id: Ic4ad9d10bb0b8afd73d2b8d58a920ae5d2b131b8
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Add GetFileHandle method to dump entry

This commit introduces the GetFileHandle method in the dump entry
interface. This method provides direct access to the Unix file
handle of the dump entry, faci

Add GetFileHandle method to dump entry

This commit introduces the GetFileHandle method in the dump entry
interface. This method provides direct access to the Unix file
handle of the dump entry, facilitating more direct read operations
on the dump file.

The returned file descriptor will be read-only, ensuring the integrity
of the dump file.

This change is primarily introduced to support the PLDM for offloading
the dump to the host and bmcweb for offloading the dump to Redfish
clients. Previously, a direct file path was provided for these
operations. However, if the applications are running in a non-root
context, they may lack the necessary access to the file. By providing
a file handle, this access issue is resolved.

Change-Id: I1c9dd5ae6dad503288f39227876e13308043fefd
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Add 'EventId' parameter to BMC Dump creation parameters

This commit adds a new 'EventId' parameter to the BMC Dump
creation parameters. The 'EventId' parameter is used to
link a BMC dump with a spec

Add 'EventId' parameter to BMC Dump creation parameters

This commit adds a new 'EventId' parameter to the BMC Dump
creation parameters. The 'EventId' parameter is used to
link a BMC dump with a specific system event, providing
clearer context and allowing for the collection of additional,
relevant diagnostic data related to the event.

Change-Id: Ia092caa42c3917febfd5e8b447f49bc9078812c2
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Update InternalFailure Type and Add Error Type Parameter

This commit modifies the 'InternalFailure' dump type and replaces
it with a more generic 'ErrorLog' type. In addition, it introduces
a new pa

Update InternalFailure Type and Add Error Type Parameter

This commit modifies the 'InternalFailure' dump type and replaces
it with a more generic 'ErrorLog' type. In addition, it introduces
a new parameter for specifying the type of the error that
triggered the dump.

This is allowing it to cater to various types of errors beyond just
internal failures. With the capability to pass architecture-specific
errors, this change increases compatibility and maintainability without
requiring alterations in the common interface YAML file for each new
error type to be supported.

Change-Id: I896bb995632dad1206385ef92819f3bfffd16f88
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Use createDump method to create different types of BMC dumps

There are two create interfaces for phosphor-debug-collector.
1- external create - this interface
Which accepts a list of key-value pairs

Use createDump method to create different types of BMC dumps

There are two create interfaces for phosphor-debug-collector.
1- external create - this interface
Which accepts a list of key-value pairs as input,
but initially, this was not accepting any parameters.

2- A create interface in phosphor-debug-collector,
which accepts the type of the BMC dump and a set of
paths to dbus or files to collect as part of dump creation.

The internal create is called by core-monitor or ramoops monitor
to create BMC dump when the error has occurred, or a core is created,
and now there is a new requirement to pass error log id along with
these create calls.

The internal create is added to pass parameters, and the external
one is always assumed as user-initiated. Since now the createDump method
is accepting additional parameters, internal create can be removed
and both system-generated and user-initiated dumps can use the
same interface and method.

This commit adds the dump type and enumeration for the types,
additionally changing the path parameter from the array of strings
to a single string because only for the core dump, there is an attempt
to send multiple paths but that can be captured in the packaging script
if the folder is sent.

Change-Id: Icbeb8499fbdfc1f8919b571495a50867bdcecac1
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

reformat with latest settings

Reformat with the latest settings from openbmc-build-scripts (and
copy latest config files where appropriate). Fix a few minor
markdownlint issues.

Signed-off-by: Pat

reformat with latest settings

Reformat with the latest settings from openbmc-build-scripts (and
copy latest config files where appropriate). Fix a few minor
markdownlint issues.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I55205817c29dc3f182a165ddf9cd5d4e07b90063

show more ...

Dump: Create: Add Unavailable error

Some types of dumps cannot be initiated when another dump
is in progress, return Unavailable error when the dump
cannot be created.

Signed-off-by: Dhruvaraj Subh

Dump: Create: Add Unavailable error

Some types of dumps cannot be initiated when another dump
is in progress, return Unavailable error when the dump
cannot be created.

Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
Change-Id: I5590181a7d6c31cd40dc1d673924b56a1a38f186

show more ...

FaultLog: Add new FaultLog dump entry interface

Fault Log is a new type of dump in openbmc/phosphor-debug-collector.
For details please see
https://github.com/openbmc/docs/blob/master/designs/hw-fau

FaultLog: Add new FaultLog dump entry interface

Fault Log is a new type of dump in openbmc/phosphor-debug-collector.
For details please see
https://github.com/openbmc/docs/blob/master/designs/hw-fault-monitor.md

This new interface (xyz.openbmc_project.Dump.Entry.FaultLog) contains
properties that are specific to Fault Log entries. Fault log entries
can contain references to fault data captured and stored by other code
modules (e.g. see the PrimaryLogId property). A fault log entry
represents a bundle of data from various sources that correspond to the
same fault event (additional properties such as references to secondary
logs may be added later).

Change-Id: I491b8fc58c752513d9066c908bf91999380e17c5
Signed-off-by: Claire Weinan <cweinan@google.com>

show more ...

Dump Entry: Recommend implementing DeleteAll

State in the description that the dump object manager should implement
xyz.openbmc_project.Collection.DeleteAll

Change-Id: I0acda3dc0bd61eb3780ed0315252

Dump Entry: Recommend implementing DeleteAll

State in the description that the dump object manager should implement
xyz.openbmc_project.Collection.DeleteAll

Change-Id: I0acda3dc0bd61eb3780ed03152521da772c95983
Signed-off-by: Claire Weinan <cweinan@google.com>

show more ...

createDump: Add Originator info as additional parameter

This commit adds "OriginatorId" & "OriginatorType" of the
"xyz.openbmc_project.Common.OriginatedBy" interface as
additional parameter in the c

createDump: Add Originator info as additional parameter

This commit adds "OriginatorId" & "OriginatorType" of the
"xyz.openbmc_project.Common.OriginatedBy" interface as
additional parameter in the createDump dbus call.

The "AdditionalData" parameter in createDump call will
be in a key-value format and the key in this case would be
"xyz.openbmc_project.Common.OriginatorId"; the value
would be any unique identifier of the user/component that
initiated the dump. This is an optional parameter and will be
implemented for user-triggered dumps.

The createDump dbus call with OriginatorId will now look like:
busctl call xyz.openbmc_project.Dump.Manager \
/xyz/openbmc_project/dump/bmc xyz.openbmc_project.Dump.Create \
CreateDump a{sv} 2 "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId" \
s "<unique-id>" "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType" \
s "<originatorType>"

Signed-off-by: Asmitha Karunanithi <asmitk01@in.ibm.com>
Change-Id: I220f20077fc069f798b40583b8918695e18152c2

show more ...

Dump: add file open error to Create interface

Add "xyz.openbmc_project.Common.File.Error.Open" to the list of errors
for the case where a dump file couldn't be opened in the course of dump
creation.

Dump: add file open error to Create interface

Add "xyz.openbmc_project.Common.File.Error.Open" to the list of errors
for the case where a dump file couldn't be opened in the course of dump
creation.

Initial usage in phosphor-debug-collector repo:
https://github.com/openbmc/phosphor-debug-collector/commit/919f71c652728da24e3e78e3ef14662265c5f812#diff-917a58c38d39e3d9353bec42ba512927c880aa5df49a3aa1700498fb17b25926R80

Signed-off-by: Claire Weinan <cweinan@google.com>
Change-Id: Ief61e89e0b5976a500447a445d90a3520ea20164

show more ...

prettier: reformat YAML

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ib7050ca82a9826efbd5ef356f546f3c33d7a2186

Dump: InitiateOffload: Add Unavailable error

The offload may not be available due to various resources
needed for offload is busy or not available in such cases
Unavailable error needs to be returne

Dump: InitiateOffload: Add Unavailable error

The offload may not be available due to various resources
needed for offload is busy or not available in such cases
Unavailable error needs to be returned.

Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
Change-Id: Ibaec718c12ed53ca83977aeb41e10d4cac2fb30f

show more ...

yaml: format with prettier

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I193f690f3612fe72ec69030f81f4d5096a761601

various: fix error metadata for systemd rules

systemd-journald requires that log statements are "KEYWORD=%printf"
and any spaces would cause the journal metadata to be dropped.
Fix a few of them I s

various: fix error metadata for systemd rules

systemd-journald requires that log statements are "KEYWORD=%printf"
and any spaces would cause the journal metadata to be dropped.
Fix a few of them I see in the repo.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I8c7f84bed0a919d5042e083bf3bd87001b10aaf9

show more ...

In dump create add type uint64 for values in additional parameters

The additional parameters passed to the dump create interfaces
are accepting a key-value pair and the value should be a string.
In

In dump create add type uint64 for values in additional parameters

The additional parameters passed to the dump create interfaces
are accepting a key-value pair and the value should be a string.
In some of the dump use cases an integer error log id needs to be
passed, it was being passed as a string. But to make it
more readable and to reduce conversion errors, updating the dict
definition to accept 32 bit unsigned integer.

Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
Change-Id: Iefc3a49c2d569a4b179fc515938349f8f84bb3ae

show more ...