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 232. requester: Expose pldm_close() in header 243. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 25 26### Deprecated 27 281. pldm_bios_table_attr_entry_integer_encode() 29 30 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 31 32### Removed 33 341. bios_table: Remove deprecated APIs sanitized by assert(): 35 36 - pldm_bios_table_string_entry_encode() 37 - pldm_bios_table_string_entry_decode_string() 38 - pldm_bios_table_attr_entry_enum_encode() 39 - pldm_bios_table_attr_entry_enum_decode_pv_num() 40 - pldm_bios_table_attr_entry_enum_decode_def_num() 41 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 42 - pldm_bios_table_attr_entry_string_encode() 43 - pldm_bios_table_attr_entry_string_decode_def_string_length() 44 45### Fixed 46 471. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 482. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 493. transport: mctp-demux: Don't test socket for non-zero value 504. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 51 52## [0.3.0] - 2023-06-23 53 54### Added 55 561. Add encode/decode pldmMessagePollEvent data 572. README: Add a section on working with libpldm 583. pdr: Introduce remote_container_id and associated APIs 594. pdr: Add APIs for creating and locating remote PDRs 605. pdr: Add pldm_pdr_find_last_in_range() 616. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 627. pdr: Add pldm_pdr_find_container_id_range_exclude() 63 64### Changed 65 661. include: Move installed transport.h under libpldm/ 672. libpldm: Explicit deprecated, stable and testing ABI classes 683. meson: Reduce strength of oem-ibm requirements from enabled to allowed 69 70 The `oem-ibm` feature is now enabled by the default meson configuration, for 71 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 72 recipe: 73 74 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 75 76 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 77 when invoking `meson setup` 78 794. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 805. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 81 82### Deprecated 83 841. bios_table: Deprecate APIs with arguments sanitized using assert() 85 86 C provides enough foot-guns without us encoding them into library APIs. 87 Specifically, deprecate the following in favour of their `*_check()` variants 88 which ensure assertions won't fail or otherwise invoke UB: 89 90 - pldm_bios_table_string_entry_encode() 91 - pldm_bios_table_string_entry_decode_string() 92 - pldm_bios_table_attr_entry_enum_encode() 93 - pldm_bios_table_attr_entry_enum_decode_pv_num() 94 - pldm_bios_table_attr_entry_enum_decode_def_num() 95 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 96 - pldm_bios_table_attr_entry_string_encode() 97 - pldm_bios_table_attr_entry_string_decode_def_string_length() 98 99### Removed 100 1011. libpldm: Remove the requester-api option 102 103### Fixed 104 1051. requester: Make pldm_open() return existing fd 1062. transport: Prevent sticking in waiting for response 1073. transport: Match on response in pldm_transport_send_recv_msg() 1084. requester: Add check before accessing hdr in pldm_recv() 1095. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 110