pdr: Stabilize APIs for removing records

- pldm_entity_association_pdr_remove_contained_entity()
- pldm_entity_association_tree_delete_node()
- pldm_pdr_delete_by_effecter_id()
- pldm_pdr_delete_by_

pdr: Stabilize APIs for removing records

- pldm_entity_association_pdr_remove_contained_entity()
- pldm_entity_association_tree_delete_node()
- pldm_pdr_delete_by_effecter_id()
- pldm_pdr_delete_by_sensor_id()
- pldm_pdr_remove_fru_record_set_by_rsi()

Use of all these APIs is demonstrated in [1].

[1]: https://gerrit.openbmc.org/c/openbmc/pldm/+/79879

Change-Id: I4dc97c4f5b60621b281d97feab79b3349432b598
Signed-off-by: Pavithra Barithaya <pavithrabarithaya07@gmail.com>
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

dsp: base: Omit checksum for Multipart receive ACKNOWLEDGE_COMPLETION

This fix is based on DSP0240 v1.2.0 section 9.6.6, Table 17
DataIntegrityChecksum property description.

DataIntegrityChecksum p

dsp: base: Omit checksum for Multipart receive ACKNOWLEDGE_COMPLETION

This fix is based on DSP0240 v1.2.0 section 9.6.6, Table 17
DataIntegrityChecksum property description.

DataIntegrityChecksum property should be there unless the
response TransferFlag property is ACKNOWLEDGE_COMPLETION

This patch fixes the issue where DataIntegrityChecksum is only
included if the TransferFlag is PLDM_END or PLDM_START_AND_END

Change-Id: I6d715d21d9d9d55bbda6139108be9cfb288ad209
Fixes: 21a639d6e67d ("dsp: base: Add encode resp for MultipartReceive command")
Signed-off-by: Kasun Athukorala <kasunath@google.com>

show more ...

dsp: base: Fix MultipartReceive Request decoding

This fix is based on DSP0240 v1.2.0 section 9.6.6 - Flag usage for
MultipartReceive (paragraph 351) and Table 17 MultipartReceive request
format.

-

dsp: base: Fix MultipartReceive Request decoding

This fix is based on DSP0240 v1.2.0 section 9.6.6 - Flag usage for
MultipartReceive (paragraph 351) and Table 17 MultipartReceive request
format.

- Removed RequestedSectionOffset check.

The Property can be 0 for any TransferOperation flag.

- Changed DataTransferHandle check.

The property can be 0 except with PLDM_XFER_NEXT_PART. Eg. In DSP0242
v1.0.0 section 9.8.2, Table 19, and DSP0240 v1.2.0 section 9.6.5, Table
17, when using MultipartReceive to read a file, the client has to send
transfer handle 0 with XFER_FIRST_PART.

Change-Id: I06428556f9dee341de97f72b015ed0347adc9454
Fixes: 9c76679224cf ("libpldm: Migrate to subproject")
Signed-off-by: Kasun Athukorala <kasunath@google.com>
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

dsp: base: decode_pldm_base_negotiate_transfer_params_resp() is stable

cb987c5c8863 ("dsp: base: Added
decode_pldm_base_negotiate_transfer_params_req()") accidentally
set `decode_pldm_base_negotiate

dsp: base: decode_pldm_base_negotiate_transfer_params_resp() is stable

cb987c5c8863 ("dsp: base: Added
decode_pldm_base_negotiate_transfer_params_req()") accidentally
set `decode_pldm_base_negotiate_transfer_params_resp()` back to
`LIBPLDM_ABI_TESTING` when it was stabilized by 26c8eb2a2f22 ("Stabilize
PLDM File Transfer related APIs").

Further, the existing integration of abi-compliance-checker was unable
to find the fault as the generated dump contained testing symbols, and
so decode_pldm_base_negotiate_transfer_params_resp() wasn't found to
be absent. We rework scripts/pre-submit such that this kind of problem
results in a CI failure.

Change-Id: I27d48e275646bbd75f19a3e1fe309a584d893cf2
Fixes: cb987c5c8863 ("dsp: base: Added decode_pldm_base_negotiate_transfer_params_req()")
Signed-off-by: Chau Ly <chaul@amperecomputing.com>
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

dsp: base: Added encode_pldm_base_negotiate_transfer_params_resp()

This command is based on DSP0240 v1.2.0 section 9.6.2
NegotiateTransferParameters (0x07).

gitlint-ignore: T1
Signed-off-by: Kasun

dsp: base: Added encode_pldm_base_negotiate_transfer_params_resp()

This command is based on DSP0240 v1.2.0 section 9.6.2
NegotiateTransferParameters (0x07).

gitlint-ignore: T1
Signed-off-by: Kasun Athukorala <kasunath@google.com>
Change-Id: I619ca0b356df065b662b16d4a469730fd145f9de

show more ...

dsp: base: Added decode_pldm_base_negotiate_transfer_params_req()

This command is based on DSP0240 v1.2.0 section 9.6.2
NegotiateTransferParameters (0x07).

gitlint-ignore: T1
Change-Id: I4fa193444d

dsp: base: Added decode_pldm_base_negotiate_transfer_params_req()

This command is based on DSP0240 v1.2.0 section 9.6.2
NegotiateTransferParameters (0x07).

gitlint-ignore: T1
Change-Id: I4fa193444df9ba5b109ca063163d7f7d109fcbda
Signed-off-by: Kasun Athukorala <kasunath@google.com>

show more ...

dsp: platform: Fix overlooked call to PLDM_MSGBUF_DEFINE_P()

In context, this should now be PLDM_MSGBUF_RW_DEFINE_P() for
const-correctness.

Fixes:

```
../src/dsp/platform.c:3550:2: error: call to

dsp: platform: Fix overlooked call to PLDM_MSGBUF_DEFINE_P()

In context, this should now be PLDM_MSGBUF_RW_DEFINE_P() for
const-correctness.

Fixes:

```
../src/dsp/platform.c:3550:2: error: call to undeclared function 'PLDM_MSGBUF_DEFINE_P'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
3550 | PLDM_MSGBUF_DEFINE_P(buf);
| ^
```

Fixes: 7a8d932bc3cd ("msgbuf: Define a separate msgbuf structure for encode/decode function")
Change-Id: I448395b6bc1f4914ca01f3edfd8c3cf7ce60a7d9
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

msgbuf: Define a separate msgbuf structure for encode/decode function

Define separate msgbuf structures to avoid casting away const-qualifiers
in the msgbuf constructor function:

* pldm_msgbuf_rw:

msgbuf: Define a separate msgbuf structure for encode/decode function

Define separate msgbuf structures to avoid casting away const-qualifiers
in the msgbuf constructor function:

* pldm_msgbuf_rw: for encode functions with non const-qualified buffer
* pldm_msgbuf_ro: for decode functions with const-qualified buffer

Further, use _Generic() to keep the API ergonomic while still yielding a
compile error when wrong msgbuf type is passed.

Change-Id: I71dbcb7996e9fb402b49870fce539a939c1497e5
Signed-off-by: John Chung <john.chung@arm.com>
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

dsp: platform: Add file PDR descriptor encoding

Change-Id: Ic1627b0ba2a4c87f4a8352e7c63eede0a2513b80
Signed-off-by: Kasun Athukorala <kasunath@google.com>

dsp: firmware_update: Stabilized new firmware package parsing ABI

Below new APIs will be consumed by openbmc/pldm[1]:
- `decode_pldm_firmware_update_package()`
- `pldm_package_firmware_device_id_r

dsp: firmware_update: Stabilized new firmware package parsing ABI

Below new APIs will be consumed by openbmc/pldm[1]:
- `decode_pldm_firmware_update_package()`
- `pldm_package_firmware_device_id_record_iter_init()`
- `decode_pldm_package_firmware_device_id_record_from_iter()`
- `pldm_package_downstream_device_id_record_iter_init()`
- `decode_pldm_package_downstream_device_id_record_from_iter()`
- `pldm_package_component_image_information_iter_init()`
- `decode_pldm_package_component_image_information_from_iter()`
- The newly added APIs uses iterators to parse the firmware update
packages, which provide the efficiency and safety benefits than the
old ones.
- The new APIs support DSP0267 v1.1.0 to v1.3.0, which provides
additional fields in the firmware update package.
- Since the old APIs will be soon marked as deprecated, this is a good
opportunity to stabilize the new APIs.
- Build pass and passed google test on CI.
- Build pass and tested successfully on Yosemite4.

[1]: https://gerrit.openbmc.org/c/openbmc/pldm/+/80194

Change-Id: I44bd1be07b0cb19a7a1044d6b36e26ffbd771285
Signed-off-by: Unive Tien <unive.tien.wiwynn@gmail.com>
Signed-off-by: Carter Chen <carter.chen.wiwynn@gmail.com>

show more ...

dsp: base: Don't extract MultipartReceive resp's CRC once complete

According to DSP0240 v1.2.0 - Table 17 MultipartReceive Request and
Response Message Format, `DataIntegrityChecksum` field:

- Shal

dsp: base: Don't extract MultipartReceive resp's CRC once complete

According to DSP0240 v1.2.0 - Table 17 MultipartReceive Request and
Response Message Format, `DataIntegrityChecksum` field:

- Shall be included with all part transfers.
- Shall be omitted in response to a request message where
TransferOperation was set to XFER_COMPLETE or XFER_ABORT.

The only possible TransferFlag in a response for a request, where
TransferOperation was set to `XFER_COMPLETE` or `XFER_ABORT`, is
`ACKNOWLEDGE_COMPLETION`. So this is the only condition to ignore the
`DataIntegrityChecksum` field.

In the current implementation, `DataIntegrityChecksum` field is only
extracted when `TransferOperation` is `END` or `START_AND_END` and this
is incorrect.

Therefore, this commit updates `decode_pldm_base_multipart_receive_resp`
function to not extract `DataIntegrityChecksum` only when `TransferFlag`
field is `ACKNOWLEDGE_COMPLETION`. This also adds 2 more unit tests for
the API, which are respectively decoding an `ACKNOWLEDGE_COMPLETION`
response with a redundant checksum field and decoding a
non-`ACKNOWLEDGE_COMPLETION` response without a checksum field.

Change-Id: I325a6393eaabfecc08f758dcae417470dde65efb
Fixes: 8836784f1e06 ("dsp: base: Add encode req & decode resp for MultipartReceive command")
Signed-off-by: Chau Ly <chaul@amperecomputing.com>

show more ...

dsp: firmware_update: Flags for decode_pldm_firmware_update_package()

Allow influencing the parser behavior down the track.

Change-Id: If63284f5c67b7a8e40d5b3176f5b8367038eb98e
Signed-off-by: Andre

dsp: firmware_update: Flags for decode_pldm_firmware_update_package()

Allow influencing the parser behavior down the track.

Change-Id: If63284f5c67b7a8e40d5b3176f5b8367038eb98e
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

dsp: firmware_update: Run-time state machine for package parsing

Encoding the necessary sequence of calls with an approximation of linear
types is hampered by DSP0267's introduction of entirely new

dsp: firmware_update: Run-time state machine for package parsing

Encoding the necessary sequence of calls with an approximation of linear
types is hampered by DSP0267's introduction of entirely new sections
into the package format across revisions. The existing design enforced a
sequence that precluded _not_ calling the decoder for downstream device
records in the case of pinning to format revision 1. The choice had the
further effect of stunting the API to future expansion of the spec.

Switch from linear types to tracking parse state at runtime based on the
provided pin and the extracted package header.

The state machine implementation is modeled on the TLA+ specification
below, with NR_FORMATS set to 4 in the model:

```tla
---- MODULE pldm_package_parser ----
EXTENDS Integers, Sequences

\* pin and format have non-deterministic init, but are then constant
VARIABLE state, pin, format

vars == << state, pin, format >>

States == {
"Init",
"Header",
"FirmwareDevices",
"DownstreamDevices",
"ComponentImageInfos",
"Complete",
"Unsupported",
"Error"
}

Formats == 1..4

DecodeHeader ==
/\ state = "Init"
/\ state' = IF format <= pin THEN "Header" ELSE "Unsupported"
/\ UNCHANGED << pin, format >>

DecodeFirmwareDevices ==
/\ state = "Header"
/\ state' = "FirmwareDevices"
/\ UNCHANGED << pin, format >>

DecodeDownstreamDevices ==
/\ state = "FirmwareDevices"
/\ state' = IF pin = 1 THEN "Error" ELSE "DownstreamDevices"
/\ UNCHANGED << pin, format >>

DecodeComponentImageInfos ==
/\ \/ /\ state = "FirmwareDevices"
/\ pin = 1
\/ /\ state = "DownstreamDevices"
/\ pin \in ( Formats \ { 1 } )
/\ state' = "Complete"
/\ UNCHANGED << pin, format >>

Done == state \in { "Complete", "Unsupported", "Error" } /\ UNCHANGED vars

Init ==
/\ state = "Init"
/\ pin \in Formats
/\ format \in Formats

Next ==
\/ DecodeHeader
\/ DecodeFirmwareDevices
\/ DecodeDownstreamDevices
\/ DecodeComponentImageInfos
\/ Done

Spec == Init /\ [][Next]_vars /\ WF_state(Next)

TypeInvariant ==
/\ state \in States
/\ pin \in Formats
/\ format \in Formats

Safety ==
/\ TypeInvariant
/\ state \in States \ { "Init", "Unsupported" } => format <= pin

Liveness ==
/\ [][(state \in { "Complete", "Unsupported", "Error" } => UNCHANGED state)]_vars
/\ [][UNCHANGED <<pin, format>>]_vars

====
```

For an introduction to TLA+ see https://www.learntla.com/

Note that the implemented state machine does not exactly replicate that
specified in the model. Specifically:

- No "Unsupported" state is defined. Instead, the APIs return -ENOTSUP
- No "Error" state is defined. Instead, the APIs return -EPROTO

It is expected that callers perform appropriate error handling.

Change-Id: Id8780c1f5f130b77e6eea2519b5d5734aa79040e
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

Stabilize PLDM File Transfer related APIs

Thit commit stabilizes PLDM File Transfer API. The APIs include:

- decode_pldm_platform_file_descriptor_pdr()
- encode_pldm_base_multipart_receive_req()
-

Stabilize PLDM File Transfer related APIs

Thit commit stabilizes PLDM File Transfer API. The APIs include:

- decode_pldm_platform_file_descriptor_pdr()
- encode_pldm_base_multipart_receive_req()
- decode_pldm_base_multipart_receive_resp()
- encode_pldm_base_negotiate_transfer_params_req()
- decode_pldm_base_negotiate_transfer_params_resp()
- encode_pldm_file_df_open_req()
- decode_pldm_file_df_open_resp()
- encode_pldm_file_df_close_req()
- decode_pldm_file_df_close_resp()
- encode_pldm_file_df_heartbeat_req()
- decode_pldm_file_df_heartbeat_resp()

Use of decode_pldm_platform_file_descriptor_pdr() is demonstrated in
[1], and the remainder in [2].

Therefore, the gcc.dump file is regenerated accordingly.

[1]: https://gerrit.openbmc.org/c/openbmc/pldm/+/82342
[2]: https://gerrit.openbmc.org/c/openbmc/pldm/+/82471

Change-Id: I6f60845b459c6fd0371925468927f8ff15ec4033
Signed-off-by: Chau Ly <chaul@amperecomputing.com>

show more ...

dsp: file: Let some encode APIs accept pointer to payload_length

In order to achieve [1], this commit updates some encoding APIs to
accept the length of the message as an in/out parameter (pointer t

dsp: file: Let some encode APIs accept pointer to payload_length

In order to achieve [1], this commit updates some encoding APIs to
accept the length of the message as an in/out parameter (pointer to
size_t). The APIs are then updated to return the encoded payload length
through this parameter.

The unit tests for these APIs are updated accordingly. The change list
includes:

- encode_pldm_file_df_open_req()
- encode_pldm_file_df_close_req()
- encode_pldm_file_df_heartbeat_req()

[1]: https://github.com/openbmc/libpldm/blob/main/CONTRIBUTING.md?plain=1#L270-L272

Change-Id: Ic81327438190bfa0541333f35e0b52a51010db91
Signed-off-by: Chau Ly <chaul@amperecomputing.com>

show more ...

dsp: base: Let some encode APIs accept pointer to payload_length

In order to achieve [1], this commit updates some encoding APIs to
accept the length of the message as an in/out parameter (pointer t

dsp: base: Let some encode APIs accept pointer to payload_length

In order to achieve [1], this commit updates some encoding APIs to
accept the length of the message as an in/out parameter (pointer to
size_t). The APIs are then updated to return the encoded payload length
through this parameter.

The unit tests for these APIs are updated accordingly. The change list
includes:

- encode_pldm_base_multipart_receive_req()
- encode_pldm_base_negotiate_transfer_params_req()

[1]: https://github.com/openbmc/libpldm/blob/main/CONTRIBUTING.md?plain=1#L270-L272

Change-Id: I17cb3641b2c4a7a30fe757a3275b1713499484cc
Signed-off-by: Chau Ly <chaul@amperecomputing.com>

show more ...

platform: Reinforce some symbol names

This commit rename some symbol names for base APIs to reinforce API
naming convention defined here [1]. The list of change includes:

1. `struct pldm_file_descr

platform: Reinforce some symbol names

This commit rename some symbol names for base APIs to reinforce API
naming convention defined here [1]. The list of change includes:

1. `struct pldm_file_descriptor_pdr` to
`struct pldm_platform_file_descriptor_pdr`
2. `decode_pldm_file_descriptor_pdr()` to
`decode_pldm_platform_file_descriptor_pdr()`

[1]: https://github.com/openbmc/libpldm/blob/main/docs/checklists/changes.md#adding-a-new-api

Change-Id: I76bd12fa59a7d61d450d9d36cbf091b39101faa8
Signed-off-by: Chau Ly <chaul@amperecomputing.com>

show more ...

base: Reinforce some symbol names

This commit renames some symbol names for base APIs to reinforce API
naming convention defined here [1]. The list of change includes:

1. `encode_base_multipart_rec

base: Reinforce some symbol names

This commit renames some symbol names for base APIs to reinforce API
naming convention defined here [1]. The list of change includes:

1. `encode_base_multipart_receive_req()` to
`encode_pldm_base_multipart_receive_req()`
2. `decode_base_multipart_receive_resp()` to
`decode_pldm_base_multipart_receive_resp()`
3. `struct pldm_multipart_receive_resp` to
`struct pldm_base_multipart_receive_resp`
4. `struct pldm_multipart_receive_req` to
`struct pldm_base_multipart_receive_req`

This also removes `__attribute__((packed))` from
`struct pldm_base_multipart_receive_req` to adapt [1].

[1]: https://github.com/openbmc/libpldm/blob/main/docs/checklists/changes.md#adding-a-new-api

Change-Id: Iefbec44efd48923fa4458228d80678a3995742e6
Signed-off-by: Chau Ly <chaul@amperecomputing.com>

show more ...

dsp: base: Implement decode_multipart_receive_req() in terms of msgbuf

Also rework related tests so we can avoid the casting the struct
over the buffers. This is motivated by an impending patch that

dsp: base: Implement decode_multipart_receive_req() in terms of msgbuf

Also rework related tests so we can avoid the casting the struct
over the buffers. This is motivated by an impending patch that drops
__attribute__((packed)) from the struct definition.

Change-Id: I21386e12ea65577920237fd28ea1fd340c749f42
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

dsp: base: Allow PLDM File Transfer use MultipartReceive decode API

MultipartReceive command in DSP0240 1.2.0 allow different PLDM Type
to use. DfRead command of PLDM File Transfer protocol (DSP0242

dsp: base: Allow PLDM File Transfer use MultipartReceive decode API

MultipartReceive command in DSP0240 1.2.0 allow different PLDM Type
to use. DfRead command of PLDM File Transfer protocol (DSP0242 1.0.0)
is one of the specific implementation of MultipartReceive.

Change-Id: I806d16a1a21bcb2b3bee5b590db2280710e624b6
Signed-off-by: John Chung <john.chung@arm.com>

show more ...

dsp: base: Add encode resp for MultipartReceive command

Added encode APIs for MultipartReceive command (0x09) that
defined in DSP0240 1.2.0 section 9.6.

Change-Id: I08eb9be3685dd6eb35e7559eb3710160

dsp: base: Add encode resp for MultipartReceive command

Added encode APIs for MultipartReceive command (0x09) that
defined in DSP0240 1.2.0 section 9.6.

Change-Id: I08eb9be3685dd6eb35e7559eb37101604409562f
Signed-off-by: John Chung <john.chung@arm.com>

show more ...

dsp: file: Add decode req & encode resp for DfOpen & DfClose command

Add encode/decode APIs for DfOpen & DfClose command
which are defined in DSP0242 Version 1.0.0 Section 9.2 & 9.3

Change-Id: I249

dsp: file: Add decode req & encode resp for DfOpen & DfClose command

Add encode/decode APIs for DfOpen & DfClose command
which are defined in DSP0242 Version 1.0.0 Section 9.2 & 9.3

Change-Id: I249b3c915b3d0a2c35be31c808a84d0800637b68
Signed-off-by: John Chung <john.chung@arm.com>

show more ...

dsp: platform: Add sensor enable responder

Add responder definitions and decode routines for
SetStateSensorEnables and SetNumericSensorEnable

Change-Id: Ic93da95f6b3cda4a99951943ebba1b1e20b95d79
Si

dsp: platform: Add sensor enable responder

Add responder definitions and decode routines for
SetStateSensorEnables and SetNumericSensorEnable

Change-Id: Ic93da95f6b3cda4a99951943ebba1b1e20b95d79
Signed-off-by: Matt Johnston <matt@codeconstruct.com.au>
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

firmware_update: Add DSP0267 v1.3.0 version updates

- Added `reference_manifest_data` and `payload_checksum` fields
to relevant data structures.
- Implemented decode functionality for these fields

firmware_update: Add DSP0267 v1.3.0 version updates

- Added `reference_manifest_data` and `payload_checksum` fields
to relevant data structures.
- Implemented decode functionality for these fields to correctly
parse their contents.
- Added unit tests for DSP0267 v1.3.0 to verify the new
decoding functionality.

Change-Id: I4403ab18daffcec5a51247a8ba6cd426072dd764
Signed-off-by: Carter Chen <carter.chen.wiwynn@gmail.com>

show more ...

utils: Add API for CRC validation

- Added the validation functions for `pldm_edac_crc32_validate`.

Motivation:
Checksum validation is a hazard for fuzzing. Provide an API that
allows us to adjust t

utils: Add API for CRC validation

- Added the validation functions for `pldm_edac_crc32_validate`.

Motivation:
Checksum validation is a hazard for fuzzing. Provide an API that
allows us to adjust the implementation of the test depending on
whether we are building to fuzz the library implementation.

Change-Id: Iffd245fe5cbcadb1037cd1f5065ccc1da6502562
Signed-off-by: Carter Chen <carter.chen.wiwynn@gmail.com>

show more ...