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 20*6409c8a0SAndrew Jeffery### Removed 21*6409c8a0SAndrew Jeffery 22*6409c8a0SAndrew Jeffery1. bios_table: Remove deprecated APIs sanitized by assert(): 23*6409c8a0SAndrew Jeffery 24*6409c8a0SAndrew Jeffery - pldm_bios_table_string_entry_encode() 25*6409c8a0SAndrew Jeffery - pldm_bios_table_string_entry_decode_string() 26*6409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_encode() 27*6409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_num() 28*6409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_def_num() 29*6409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 30*6409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_string_encode() 31*6409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_string_decode_def_string_length() 32*6409c8a0SAndrew Jeffery 33291da195SAndrew Jeffery## [0.3.0] - 2023-06-23 34291da195SAndrew Jeffery 357c250340SDung Cao### Added 367c250340SDung Cao 377c250340SDung Cao1. Add encode/decode pldmMessagePollEvent data 3883841fb5SAndrew Jeffery2. README: Add a section on working with libpldm 3939bd2ea5SArchanaKakani3. pdr: Introduce remote_container_id and associated APIs 409947f9d6SPavithra Barithaya4. pdr: Add APIs for creating and locating remote PDRs 414d694346SPavithra Barithaya5. pdr: Add pldm_pdr_find_last_in_range() 4225ddbccfSPavithra Barithaya6. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 435dc02571SPavithra Barithaya7. pdr: Add pldm_pdr_find_container_id_range_exclude() 447c250340SDung Cao 45b443b487SRashmica Gupta### Changed 46b443b487SRashmica Gupta 47b443b487SRashmica Gupta1. include: Move installed transport.h under libpldm/ 4883841fb5SAndrew Jeffery2. libpldm: Explicit deprecated, stable and testing ABI classes 498de8e1ecSAndrew Jeffery3. meson: Reduce strength of oem-ibm requirements from enabled to allowed 508de8e1ecSAndrew Jeffery 518de8e1ecSAndrew Jeffery The `oem-ibm` feature is now enabled by the default meson configuration, for 528de8e1ecSAndrew Jeffery CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 538de8e1ecSAndrew Jeffery recipe: 548de8e1ecSAndrew Jeffery 558de8e1ecSAndrew Jeffery https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 568de8e1ecSAndrew Jeffery 578de8e1ecSAndrew Jeffery To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 588de8e1ecSAndrew Jeffery when invoking `meson setup` 59b443b487SRashmica Gupta 6098c1e69dSAndrew Jeffery4. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 610c9f5a8aSAndrew Jeffery5. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 6298c1e69dSAndrew Jeffery 63d47e8ab8SAndrew Jeffery### Deprecated 64d47e8ab8SAndrew Jeffery 65d47e8ab8SAndrew Jeffery1. bios_table: Deprecate APIs with arguments sanitized using assert() 66d47e8ab8SAndrew Jeffery 67d47e8ab8SAndrew Jeffery C provides enough foot-guns without us encoding them into library APIs. 68d47e8ab8SAndrew Jeffery Specifically, deprecate the following in favour of their `*_check()` variants 69d47e8ab8SAndrew Jeffery which ensure assertions won't fail or otherwise invoke UB: 70d47e8ab8SAndrew Jeffery 71d47e8ab8SAndrew Jeffery - pldm_bios_table_string_entry_encode() 72d47e8ab8SAndrew Jeffery - pldm_bios_table_string_entry_decode_string() 73d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_encode() 74d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_num() 75d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_def_num() 76d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 77d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_string_encode() 78d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_string_decode_def_string_length() 79d47e8ab8SAndrew Jeffery 804b4603b3SAndrew Jeffery### Removed 814b4603b3SAndrew Jeffery 824b4603b3SAndrew Jeffery1. libpldm: Remove the requester-api option 834b4603b3SAndrew Jeffery 8439f88325SRashmica Gupta### Fixed 8539f88325SRashmica Gupta 8639f88325SRashmica Gupta1. requester: Make pldm_open() return existing fd 87abaf61f4SDung Cao2. transport: Prevent sticking in waiting for response 88b01fb1ccSThu Nguyen3. transport: Match on response in pldm_transport_send_recv_msg() 89a3035938SRashmica Gupta4. requester: Add check before accessing hdr in pldm_recv() 90df02e360SAndrew Jeffery5. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 91