xref: /openbmc/libpldm/CHANGELOG.md (revision 0088a6ae4cec3eb2e8e4dece6fb54e535111790c)
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
404. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer()
41
42   Migrate to pldm_bios_table_attr_value_entry_encode_integer_check()
43
44### Removed
45
461. bios_table: Remove deprecated APIs sanitized by assert():
47
48   - pldm_bios_table_string_entry_encode()
49   - pldm_bios_table_string_entry_decode_string()
50   - pldm_bios_table_attr_entry_enum_encode()
51   - pldm_bios_table_attr_entry_enum_decode_pv_num()
52   - pldm_bios_table_attr_entry_enum_decode_def_num()
53   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
54   - pldm_bios_table_attr_entry_string_encode()
55   - pldm_bios_table_attr_entry_string_decode_def_string_length()
56
57### Fixed
58
591. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API
602. pdr: Rework pldm_pdr_find_container_id_range_exclude() API
613. transport: mctp-demux: Don't test socket for non-zero value
624. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error
63
64## [0.3.0] - 2023-06-23
65
66### Added
67
681. Add encode/decode pldmMessagePollEvent data
692. README: Add a section on working with libpldm
703. pdr: Introduce remote_container_id and associated APIs
714. pdr: Add APIs for creating and locating remote PDRs
725. pdr: Add pldm_pdr_find_last_in_range()
736. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
747. pdr: Add pldm_pdr_find_container_id_range_exclude()
75
76### Changed
77
781. include: Move installed transport.h under libpldm/
792. libpldm: Explicit deprecated, stable and testing ABI classes
803. meson: Reduce strength of oem-ibm requirements from enabled to allowed
81
82   The `oem-ibm` feature is now enabled by the default meson configuration, for
83   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
84   recipe:
85
86   https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10
87
88   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
89   when invoking `meson setup`
90
914. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
925. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
93
94### Deprecated
95
961. bios_table: Deprecate APIs with arguments sanitized using assert()
97
98   C provides enough foot-guns without us encoding them into library APIs.
99   Specifically, deprecate the following in favour of their `*_check()` variants
100   which ensure assertions won't fail or otherwise invoke UB:
101
102   - pldm_bios_table_string_entry_encode()
103   - pldm_bios_table_string_entry_decode_string()
104   - pldm_bios_table_attr_entry_enum_encode()
105   - pldm_bios_table_attr_entry_enum_decode_pv_num()
106   - pldm_bios_table_attr_entry_enum_decode_def_num()
107   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
108   - pldm_bios_table_attr_entry_string_encode()
109   - pldm_bios_table_attr_entry_string_decode_def_string_length()
110
111### Removed
112
1131. libpldm: Remove the requester-api option
114
115### Fixed
116
1171. requester: Make pldm_open() return existing fd
1182. transport: Prevent sticking in waiting for response
1193. transport: Match on response in pldm_transport_send_recv_msg()
1204. requester: Add check before accessing hdr in pldm_recv()
1215. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
122