xref: /openbmc/libpldm/CHANGELOG.md (revision 5fb9680b39f14279a2a6d66a1e844843802774ca)
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
24
25### Removed
26
271. bios_table: Remove deprecated APIs sanitized by assert():
28
29   - pldm_bios_table_string_entry_encode()
30   - pldm_bios_table_string_entry_decode_string()
31   - pldm_bios_table_attr_entry_enum_encode()
32   - pldm_bios_table_attr_entry_enum_decode_pv_num()
33   - pldm_bios_table_attr_entry_enum_decode_def_num()
34   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
35   - pldm_bios_table_attr_entry_string_encode()
36   - pldm_bios_table_attr_entry_string_decode_def_string_length()
37
38### Fixed
39
401. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API
412. pdr: Rework pldm_pdr_find_container_id_range_exclude() API
42
43## [0.3.0] - 2023-06-23
44
45### Added
46
471. Add encode/decode pldmMessagePollEvent data
482. README: Add a section on working with libpldm
493. pdr: Introduce remote_container_id and associated APIs
504. pdr: Add APIs for creating and locating remote PDRs
515. pdr: Add pldm_pdr_find_last_in_range()
526. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
537. pdr: Add pldm_pdr_find_container_id_range_exclude()
54
55### Changed
56
571. include: Move installed transport.h under libpldm/
582. libpldm: Explicit deprecated, stable and testing ABI classes
593. meson: Reduce strength of oem-ibm requirements from enabled to allowed
60
61   The `oem-ibm` feature is now enabled by the default meson configuration, for
62   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
63   recipe:
64
65   https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10
66
67   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
68   when invoking `meson setup`
69
704. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
715. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
72
73### Deprecated
74
751. bios_table: Deprecate APIs with arguments sanitized using assert()
76
77   C provides enough foot-guns without us encoding them into library APIs.
78   Specifically, deprecate the following in favour of their `*_check()` variants
79   which ensure assertions won't fail or otherwise invoke UB:
80
81   - pldm_bios_table_string_entry_encode()
82   - pldm_bios_table_string_entry_decode_string()
83   - pldm_bios_table_attr_entry_enum_encode()
84   - pldm_bios_table_attr_entry_enum_decode_pv_num()
85   - pldm_bios_table_attr_entry_enum_decode_def_num()
86   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
87   - pldm_bios_table_attr_entry_string_encode()
88   - pldm_bios_table_attr_entry_string_decode_def_string_length()
89
90### Removed
91
921. libpldm: Remove the requester-api option
93
94### Fixed
95
961. requester: Make pldm_open() return existing fd
972. transport: Prevent sticking in waiting for response
983. transport: Match on response in pldm_transport_send_recv_msg()
994. requester: Add check before accessing hdr in pldm_recv()
1005. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
101