xref: /openbmc/libpldm/CHANGELOG.md (revision 2d66393f0d2f9c4acf21c18ef50e3e5f6eea60f8)
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
363. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string()
37
38   Migrate to pldm_bios_table_attr_value_entry_encode_string_check()
39
40### Removed
41
421. bios_table: Remove deprecated APIs sanitized by assert():
43
44   - pldm_bios_table_string_entry_encode()
45   - pldm_bios_table_string_entry_decode_string()
46   - pldm_bios_table_attr_entry_enum_encode()
47   - pldm_bios_table_attr_entry_enum_decode_pv_num()
48   - pldm_bios_table_attr_entry_enum_decode_def_num()
49   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
50   - pldm_bios_table_attr_entry_string_encode()
51   - pldm_bios_table_attr_entry_string_decode_def_string_length()
52
53### Fixed
54
551. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API
562. pdr: Rework pldm_pdr_find_container_id_range_exclude() API
573. transport: mctp-demux: Don't test socket for non-zero value
584. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error
59
60## [0.3.0] - 2023-06-23
61
62### Added
63
641. Add encode/decode pldmMessagePollEvent data
652. README: Add a section on working with libpldm
663. pdr: Introduce remote_container_id and associated APIs
674. pdr: Add APIs for creating and locating remote PDRs
685. pdr: Add pldm_pdr_find_last_in_range()
696. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
707. pdr: Add pldm_pdr_find_container_id_range_exclude()
71
72### Changed
73
741. include: Move installed transport.h under libpldm/
752. libpldm: Explicit deprecated, stable and testing ABI classes
763. meson: Reduce strength of oem-ibm requirements from enabled to allowed
77
78   The `oem-ibm` feature is now enabled by the default meson configuration, for
79   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
80   recipe:
81
82   https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10
83
84   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
85   when invoking `meson setup`
86
874. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
885. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
89
90### Deprecated
91
921. bios_table: Deprecate APIs with arguments sanitized using assert()
93
94   C provides enough foot-guns without us encoding them into library APIs.
95   Specifically, deprecate the following in favour of their `*_check()` variants
96   which ensure assertions won't fail or otherwise invoke UB:
97
98   - pldm_bios_table_string_entry_encode()
99   - pldm_bios_table_string_entry_decode_string()
100   - pldm_bios_table_attr_entry_enum_encode()
101   - pldm_bios_table_attr_entry_enum_decode_pv_num()
102   - pldm_bios_table_attr_entry_enum_decode_def_num()
103   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
104   - pldm_bios_table_attr_entry_string_encode()
105   - pldm_bios_table_attr_entry_string_decode_def_string_length()
106
107### Removed
108
1091. libpldm: Remove the requester-api option
110
111### Fixed
112
1131. requester: Make pldm_open() return existing fd
1142. transport: Prevent sticking in waiting for response
1153. transport: Match on response in pldm_transport_send_recv_msg()
1164. requester: Add check before accessing hdr in pldm_recv()
1175. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
118