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 20986df2a1SAndrew Jeffery### Changed 21986df2a1SAndrew Jeffery 22986df2a1SAndrew Jeffery1. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 23*5fb9680bSAndrew Jeffery2. requester: Expose pldm_close() in header 24986df2a1SAndrew Jeffery 256409c8a0SAndrew Jeffery### Removed 266409c8a0SAndrew Jeffery 276409c8a0SAndrew Jeffery1. bios_table: Remove deprecated APIs sanitized by assert(): 286409c8a0SAndrew Jeffery 296409c8a0SAndrew Jeffery - pldm_bios_table_string_entry_encode() 306409c8a0SAndrew Jeffery - pldm_bios_table_string_entry_decode_string() 316409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_encode() 326409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_num() 336409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_def_num() 346409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 356409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_string_encode() 366409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_string_decode_def_string_length() 376409c8a0SAndrew Jeffery 3809778a82SAndrew Jeffery### Fixed 39ffd5342cSPavithra Barithaya 40ffd5342cSPavithra Barithaya1. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 418cf70456SPavithra Barithaya2. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 42ffd5342cSPavithra Barithaya 43291da195SAndrew Jeffery## [0.3.0] - 2023-06-23 44291da195SAndrew Jeffery 457c250340SDung Cao### Added 467c250340SDung Cao 477c250340SDung Cao1. Add encode/decode pldmMessagePollEvent data 4883841fb5SAndrew Jeffery2. README: Add a section on working with libpldm 4939bd2ea5SArchanaKakani3. pdr: Introduce remote_container_id and associated APIs 509947f9d6SPavithra Barithaya4. pdr: Add APIs for creating and locating remote PDRs 514d694346SPavithra Barithaya5. pdr: Add pldm_pdr_find_last_in_range() 5225ddbccfSPavithra Barithaya6. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 535dc02571SPavithra Barithaya7. pdr: Add pldm_pdr_find_container_id_range_exclude() 547c250340SDung Cao 55b443b487SRashmica Gupta### Changed 56b443b487SRashmica Gupta 57b443b487SRashmica Gupta1. include: Move installed transport.h under libpldm/ 5883841fb5SAndrew Jeffery2. libpldm: Explicit deprecated, stable and testing ABI classes 598de8e1ecSAndrew Jeffery3. meson: Reduce strength of oem-ibm requirements from enabled to allowed 608de8e1ecSAndrew Jeffery 618de8e1ecSAndrew Jeffery The `oem-ibm` feature is now enabled by the default meson configuration, for 628de8e1ecSAndrew Jeffery CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 638de8e1ecSAndrew Jeffery recipe: 648de8e1ecSAndrew Jeffery 658de8e1ecSAndrew Jeffery https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 668de8e1ecSAndrew Jeffery 678de8e1ecSAndrew Jeffery To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 688de8e1ecSAndrew Jeffery when invoking `meson setup` 69b443b487SRashmica Gupta 7098c1e69dSAndrew Jeffery4. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 710c9f5a8aSAndrew Jeffery5. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 7298c1e69dSAndrew Jeffery 73d47e8ab8SAndrew Jeffery### Deprecated 74d47e8ab8SAndrew Jeffery 75d47e8ab8SAndrew Jeffery1. bios_table: Deprecate APIs with arguments sanitized using assert() 76d47e8ab8SAndrew Jeffery 77d47e8ab8SAndrew Jeffery C provides enough foot-guns without us encoding them into library APIs. 78d47e8ab8SAndrew Jeffery Specifically, deprecate the following in favour of their `*_check()` variants 79d47e8ab8SAndrew Jeffery which ensure assertions won't fail or otherwise invoke UB: 80d47e8ab8SAndrew Jeffery 81d47e8ab8SAndrew Jeffery - pldm_bios_table_string_entry_encode() 82d47e8ab8SAndrew Jeffery - pldm_bios_table_string_entry_decode_string() 83d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_encode() 84d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_num() 85d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_def_num() 86d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 87d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_string_encode() 88d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_string_decode_def_string_length() 89d47e8ab8SAndrew Jeffery 904b4603b3SAndrew Jeffery### Removed 914b4603b3SAndrew Jeffery 924b4603b3SAndrew Jeffery1. libpldm: Remove the requester-api option 934b4603b3SAndrew Jeffery 9439f88325SRashmica Gupta### Fixed 9539f88325SRashmica Gupta 9639f88325SRashmica Gupta1. requester: Make pldm_open() return existing fd 97abaf61f4SDung Cao2. transport: Prevent sticking in waiting for response 98b01fb1ccSThu Nguyen3. transport: Match on response in pldm_transport_send_recv_msg() 99a3035938SRashmica Gupta4. requester: Add check before accessing hdr in pldm_recv() 100df02e360SAndrew Jeffery5. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 101