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 322. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 33 34 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 35 36### Removed 37 381. bios_table: Remove deprecated APIs sanitized by assert(): 39 40 - pldm_bios_table_string_entry_encode() 41 - pldm_bios_table_string_entry_decode_string() 42 - pldm_bios_table_attr_entry_enum_encode() 43 - pldm_bios_table_attr_entry_enum_decode_pv_num() 44 - pldm_bios_table_attr_entry_enum_decode_def_num() 45 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 46 - pldm_bios_table_attr_entry_string_encode() 47 - pldm_bios_table_attr_entry_string_decode_def_string_length() 48 49### Fixed 50 511. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 522. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 533. transport: mctp-demux: Don't test socket for non-zero value 544. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 55 56## [0.3.0] - 2023-06-23 57 58### Added 59 601. Add encode/decode pldmMessagePollEvent data 612. README: Add a section on working with libpldm 623. pdr: Introduce remote_container_id and associated APIs 634. pdr: Add APIs for creating and locating remote PDRs 645. pdr: Add pldm_pdr_find_last_in_range() 656. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 667. pdr: Add pldm_pdr_find_container_id_range_exclude() 67 68### Changed 69 701. include: Move installed transport.h under libpldm/ 712. libpldm: Explicit deprecated, stable and testing ABI classes 723. meson: Reduce strength of oem-ibm requirements from enabled to allowed 73 74 The `oem-ibm` feature is now enabled by the default meson configuration, for 75 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 76 recipe: 77 78 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 79 80 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 81 when invoking `meson setup` 82 834. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 845. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 85 86### Deprecated 87 881. bios_table: Deprecate APIs with arguments sanitized using assert() 89 90 C provides enough foot-guns without us encoding them into library APIs. 91 Specifically, deprecate the following in favour of their `*_check()` variants 92 which ensure assertions won't fail or otherwise invoke UB: 93 94 - pldm_bios_table_string_entry_encode() 95 - pldm_bios_table_string_entry_decode_string() 96 - pldm_bios_table_attr_entry_enum_encode() 97 - pldm_bios_table_attr_entry_enum_decode_pv_num() 98 - pldm_bios_table_attr_entry_enum_decode_def_num() 99 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 100 - pldm_bios_table_attr_entry_string_encode() 101 - pldm_bios_table_attr_entry_string_decode_def_string_length() 102 103### Removed 104 1051. libpldm: Remove the requester-api option 106 107### Fixed 108 1091. requester: Make pldm_open() return existing fd 1102. transport: Prevent sticking in waiting for response 1113. transport: Match on response in pldm_transport_send_recv_msg() 1124. requester: Add check before accessing hdr in pldm_recv() 1135. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 114