xref: /openbmc/libpldm/CHANGELOG.md (revision 5dc025719dc3cc7369b23f81bcf1e792df50d489)
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### Added
21
221. Add encode/decode pldmMessagePollEvent data
232. README: Add a section on working with libpldm
243. pdr: Introduce remote_container_id and associated APIs
254. pdr: Add APIs for creating and locating remote PDRs
265. pdr: Add pldm_pdr_find_last_in_range()
276. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
287. pdr: Add pldm_pdr_find_container_id_range_exclude()
29
30### Changed
31
321. include: Move installed transport.h under libpldm/
332. libpldm: Explicit deprecated, stable and testing ABI classes
343. meson: Reduce strength of oem-ibm requirements from enabled to allowed
35
36   The `oem-ibm` feature is now enabled by the default meson configuration, for
37   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
38   recipe:
39
40   https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10
41
42   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
43   when invoking `meson setup`
44
454. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
465. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
47
48### Deprecated
49
501. bios_table: Deprecate APIs with arguments sanitized using assert()
51
52   C provides enough foot-guns without us encoding them into library APIs.
53   Specifically, deprecate the following in favour of their `*_check()` variants
54   which ensure assertions won't fail or otherwise invoke UB:
55
56   - pldm_bios_table_string_entry_encode()
57   - pldm_bios_table_string_entry_decode_string()
58   - pldm_bios_table_attr_entry_enum_encode()
59   - pldm_bios_table_attr_entry_enum_decode_pv_num()
60   - pldm_bios_table_attr_entry_enum_decode_def_num()
61   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
62   - pldm_bios_table_attr_entry_string_encode()
63   - pldm_bios_table_attr_entry_string_decode_def_string_length()
64
65### Removed
66
671. libpldm: Remove the requester-api option
68
69### Fixed
70
711. requester: Make pldm_open() return existing fd
722. transport: Prevent sticking in waiting for response
733. transport: Match on response in pldm_transport_send_recv_msg()
744. requester: Add check before accessing hdr in pldm_recv()
755. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
76