16fd81a51SAndrew Jeffery# Changelog 26fd81a51SAndrew Jeffery 36fd81a51SAndrew JefferyAll notable changes to this project will be documented in this file. 46fd81a51SAndrew Jeffery 56fd81a51SAndrew JefferyThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 66fd81a51SAndrew Jefferyand this project adheres to 76fd81a51SAndrew Jeffery[Semantic Versioning](https://semver.org/spec/v2.0.0.html). 86fd81a51SAndrew Jeffery 96fd81a51SAndrew JefferyChange categories: 106fd81a51SAndrew Jeffery 116fd81a51SAndrew Jeffery- Added 126fd81a51SAndrew Jeffery- Changed 136fd81a51SAndrew Jeffery- Deprecated 146fd81a51SAndrew Jeffery- Removed 156fd81a51SAndrew Jeffery- Fixed 166fd81a51SAndrew Jeffery- Security 176fd81a51SAndrew Jeffery 186fd81a51SAndrew Jeffery## [Unreleased] 1939f88325SRashmica Gupta 207c250340SDung Cao### Added 217c250340SDung Cao 227c250340SDung Cao1. Add encode/decode pldmMessagePollEvent data 2383841fb5SAndrew Jeffery2. README: Add a section on working with libpldm 2439bd2ea5SArchanaKakani3. pdr: Introduce remote_container_id and associated APIs 259947f9d6SPavithra Barithaya4. pdr: Add APIs for creating and locating remote PDRs 264d694346SPavithra Barithaya5. pdr: Add pldm_pdr_find_last_in_range() 2725ddbccfSPavithra Barithaya6. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 28*5dc02571SPavithra Barithaya7. pdr: Add pldm_pdr_find_container_id_range_exclude() 297c250340SDung Cao 30b443b487SRashmica Gupta### Changed 31b443b487SRashmica Gupta 32b443b487SRashmica Gupta1. include: Move installed transport.h under libpldm/ 3383841fb5SAndrew Jeffery2. libpldm: Explicit deprecated, stable and testing ABI classes 348de8e1ecSAndrew Jeffery3. meson: Reduce strength of oem-ibm requirements from enabled to allowed 358de8e1ecSAndrew Jeffery 368de8e1ecSAndrew Jeffery The `oem-ibm` feature is now enabled by the default meson configuration, for 378de8e1ecSAndrew Jeffery CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 388de8e1ecSAndrew Jeffery recipe: 398de8e1ecSAndrew Jeffery 408de8e1ecSAndrew Jeffery https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 418de8e1ecSAndrew Jeffery 428de8e1ecSAndrew Jeffery To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 438de8e1ecSAndrew Jeffery when invoking `meson setup` 44b443b487SRashmica Gupta 4598c1e69dSAndrew Jeffery4. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 460c9f5a8aSAndrew Jeffery5. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 4798c1e69dSAndrew Jeffery 48d47e8ab8SAndrew Jeffery### Deprecated 49d47e8ab8SAndrew Jeffery 50d47e8ab8SAndrew Jeffery1. bios_table: Deprecate APIs with arguments sanitized using assert() 51d47e8ab8SAndrew Jeffery 52d47e8ab8SAndrew Jeffery C provides enough foot-guns without us encoding them into library APIs. 53d47e8ab8SAndrew Jeffery Specifically, deprecate the following in favour of their `*_check()` variants 54d47e8ab8SAndrew Jeffery which ensure assertions won't fail or otherwise invoke UB: 55d47e8ab8SAndrew Jeffery 56d47e8ab8SAndrew Jeffery - pldm_bios_table_string_entry_encode() 57d47e8ab8SAndrew Jeffery - pldm_bios_table_string_entry_decode_string() 58d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_encode() 59d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_num() 60d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_def_num() 61d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 62d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_string_encode() 63d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_string_decode_def_string_length() 64d47e8ab8SAndrew Jeffery 654b4603b3SAndrew Jeffery### Removed 664b4603b3SAndrew Jeffery 674b4603b3SAndrew Jeffery1. libpldm: Remove the requester-api option 684b4603b3SAndrew Jeffery 6939f88325SRashmica Gupta### Fixed 7039f88325SRashmica Gupta 7139f88325SRashmica Gupta1. requester: Make pldm_open() return existing fd 72abaf61f4SDung Cao2. transport: Prevent sticking in waiting for response 73b01fb1ccSThu Nguyen3. transport: Match on response in pldm_transport_send_recv_msg() 74a3035938SRashmica Gupta4. requester: Add check before accessing hdr in pldm_recv() 75df02e360SAndrew Jeffery5. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 76