1# Changelog 2 3All notable changes to this project will be documented in this file. 4 5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 6and this project adheres to 7[Semantic Versioning](https://semver.org/spec/v2.0.0.html). 8 9Change categories: 10 11- Added 12- Changed 13- Deprecated 14- Removed 15- Fixed 16- Security 17 18## [Unreleased] 19 20### Changed 21 221. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 23 24### Removed 25 261. bios_table: Remove deprecated APIs sanitized by assert(): 27 28 - pldm_bios_table_string_entry_encode() 29 - pldm_bios_table_string_entry_decode_string() 30 - pldm_bios_table_attr_entry_enum_encode() 31 - pldm_bios_table_attr_entry_enum_decode_pv_num() 32 - pldm_bios_table_attr_entry_enum_decode_def_num() 33 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 34 - pldm_bios_table_attr_entry_string_encode() 35 - pldm_bios_table_attr_entry_string_decode_def_string_length() 36 37### Fixed 38 391. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 402. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 41 42## [0.3.0] - 2023-06-23 43 44### Added 45 461. Add encode/decode pldmMessagePollEvent data 472. README: Add a section on working with libpldm 483. pdr: Introduce remote_container_id and associated APIs 494. pdr: Add APIs for creating and locating remote PDRs 505. pdr: Add pldm_pdr_find_last_in_range() 516. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 527. pdr: Add pldm_pdr_find_container_id_range_exclude() 53 54### Changed 55 561. include: Move installed transport.h under libpldm/ 572. libpldm: Explicit deprecated, stable and testing ABI classes 583. meson: Reduce strength of oem-ibm requirements from enabled to allowed 59 60 The `oem-ibm` feature is now enabled by the default meson configuration, for 61 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 62 recipe: 63 64 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 65 66 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 67 when invoking `meson setup` 68 694. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 705. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 71 72### Deprecated 73 741. bios_table: Deprecate APIs with arguments sanitized using assert() 75 76 C provides enough foot-guns without us encoding them into library APIs. 77 Specifically, deprecate the following in favour of their `*_check()` variants 78 which ensure assertions won't fail or otherwise invoke UB: 79 80 - pldm_bios_table_string_entry_encode() 81 - pldm_bios_table_string_entry_decode_string() 82 - pldm_bios_table_attr_entry_enum_encode() 83 - pldm_bios_table_attr_entry_enum_decode_pv_num() 84 - pldm_bios_table_attr_entry_enum_decode_def_num() 85 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 86 - pldm_bios_table_attr_entry_string_encode() 87 - pldm_bios_table_attr_entry_string_decode_def_string_length() 88 89### Removed 90 911. libpldm: Remove the requester-api option 92 93### Fixed 94 951. requester: Make pldm_open() return existing fd 962. transport: Prevent sticking in waiting for response 973. transport: Match on response in pldm_transport_send_recv_msg() 984. requester: Add check before accessing hdr in pldm_recv() 995. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 100