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*044ee19aSAndrew Jeffery### Added 21*044ee19aSAndrew Jeffery 22*044ee19aSAndrew Jeffery1. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 23*044ee19aSAndrew Jeffery 24986df2a1SAndrew Jeffery### Changed 25986df2a1SAndrew Jeffery 26986df2a1SAndrew Jeffery1. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 275fb9680bSAndrew Jeffery2. requester: Expose pldm_close() in header 28a873eca0SAndrew Jeffery3. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 29986df2a1SAndrew Jeffery 30fe0f01d8SAndrew Jeffery### Deprecated 31fe0f01d8SAndrew Jeffery 32fe0f01d8SAndrew Jeffery1. pldm_bios_table_attr_entry_integer_encode() 33fe0f01d8SAndrew Jeffery 34fe0f01d8SAndrew Jeffery Migrate to pldm_bios_table_attr_entry_integer_encode_check() 35fe0f01d8SAndrew Jeffery 367aeb7edbSAndrew Jeffery2. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 377aeb7edbSAndrew Jeffery 387aeb7edbSAndrew Jeffery Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 397aeb7edbSAndrew Jeffery 402d66393fSAndrew Jeffery3. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 412d66393fSAndrew Jeffery 422d66393fSAndrew Jeffery Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 432d66393fSAndrew Jeffery 440088a6aeSAndrew Jeffery4. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 450088a6aeSAndrew Jeffery 460088a6aeSAndrew Jeffery Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 470088a6aeSAndrew Jeffery 486409c8a0SAndrew Jeffery### Removed 496409c8a0SAndrew Jeffery 506409c8a0SAndrew Jeffery1. bios_table: Remove deprecated APIs sanitized by assert(): 516409c8a0SAndrew Jeffery 526409c8a0SAndrew Jeffery - pldm_bios_table_string_entry_encode() 536409c8a0SAndrew Jeffery - pldm_bios_table_string_entry_decode_string() 546409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_encode() 556409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_num() 566409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_def_num() 576409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 586409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_string_encode() 596409c8a0SAndrew Jeffery - pldm_bios_table_attr_entry_string_decode_def_string_length() 606409c8a0SAndrew Jeffery 6109778a82SAndrew Jeffery### Fixed 62ffd5342cSPavithra Barithaya 63ffd5342cSPavithra Barithaya1. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 648cf70456SPavithra Barithaya2. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 65a4da6858SAndrew Jeffery3. transport: mctp-demux: Don't test socket for non-zero value 664e1ba8a7SAndrew Jeffery4. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 67ffd5342cSPavithra Barithaya 68291da195SAndrew Jeffery## [0.3.0] - 2023-06-23 69291da195SAndrew Jeffery 707c250340SDung Cao### Added 717c250340SDung Cao 727c250340SDung Cao1. Add encode/decode pldmMessagePollEvent data 7383841fb5SAndrew Jeffery2. README: Add a section on working with libpldm 7439bd2ea5SArchanaKakani3. pdr: Introduce remote_container_id and associated APIs 759947f9d6SPavithra Barithaya4. pdr: Add APIs for creating and locating remote PDRs 764d694346SPavithra Barithaya5. pdr: Add pldm_pdr_find_last_in_range() 7725ddbccfSPavithra Barithaya6. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 785dc02571SPavithra Barithaya7. pdr: Add pldm_pdr_find_container_id_range_exclude() 797c250340SDung Cao 80b443b487SRashmica Gupta### Changed 81b443b487SRashmica Gupta 82b443b487SRashmica Gupta1. include: Move installed transport.h under libpldm/ 8383841fb5SAndrew Jeffery2. libpldm: Explicit deprecated, stable and testing ABI classes 848de8e1ecSAndrew Jeffery3. meson: Reduce strength of oem-ibm requirements from enabled to allowed 858de8e1ecSAndrew Jeffery 868de8e1ecSAndrew Jeffery The `oem-ibm` feature is now enabled by the default meson configuration, for 878de8e1ecSAndrew Jeffery CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 888de8e1ecSAndrew Jeffery recipe: 898de8e1ecSAndrew Jeffery 908de8e1ecSAndrew Jeffery https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 918de8e1ecSAndrew Jeffery 928de8e1ecSAndrew Jeffery To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 938de8e1ecSAndrew Jeffery when invoking `meson setup` 94b443b487SRashmica Gupta 9598c1e69dSAndrew Jeffery4. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 960c9f5a8aSAndrew Jeffery5. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 9798c1e69dSAndrew Jeffery 98d47e8ab8SAndrew Jeffery### Deprecated 99d47e8ab8SAndrew Jeffery 100d47e8ab8SAndrew Jeffery1. bios_table: Deprecate APIs with arguments sanitized using assert() 101d47e8ab8SAndrew Jeffery 102d47e8ab8SAndrew Jeffery C provides enough foot-guns without us encoding them into library APIs. 103d47e8ab8SAndrew Jeffery Specifically, deprecate the following in favour of their `*_check()` variants 104d47e8ab8SAndrew Jeffery which ensure assertions won't fail or otherwise invoke UB: 105d47e8ab8SAndrew Jeffery 106d47e8ab8SAndrew Jeffery - pldm_bios_table_string_entry_encode() 107d47e8ab8SAndrew Jeffery - pldm_bios_table_string_entry_decode_string() 108d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_encode() 109d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_num() 110d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_def_num() 111d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 112d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_string_encode() 113d47e8ab8SAndrew Jeffery - pldm_bios_table_attr_entry_string_decode_def_string_length() 114d47e8ab8SAndrew Jeffery 1154b4603b3SAndrew Jeffery### Removed 1164b4603b3SAndrew Jeffery 1174b4603b3SAndrew Jeffery1. libpldm: Remove the requester-api option 1184b4603b3SAndrew Jeffery 11939f88325SRashmica Gupta### Fixed 12039f88325SRashmica Gupta 12139f88325SRashmica Gupta1. requester: Make pldm_open() return existing fd 122abaf61f4SDung Cao2. transport: Prevent sticking in waiting for response 123b01fb1ccSThu Nguyen3. transport: Match on response in pldm_transport_send_recv_msg() 124a3035938SRashmica Gupta4. requester: Add check before accessing hdr in pldm_recv() 125df02e360SAndrew Jeffery5. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 126