xref: /openbmc/libpldm/CHANGELOG.md (revision ffd5342c4f684c9e4e8fa6a1a4430c0dda80d6ce)
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### Removed
21
221. bios_table: Remove deprecated APIs sanitized by assert():
23
24   - pldm_bios_table_string_entry_encode()
25   - pldm_bios_table_string_entry_decode_string()
26   - pldm_bios_table_attr_entry_enum_encode()
27   - pldm_bios_table_attr_entry_enum_decode_pv_num()
28   - pldm_bios_table_attr_entry_enum_decode_def_num()
29   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
30   - pldm_bios_table_attr_entry_string_encode()
31   - pldm_bios_table_attr_entry_string_decode_def_string_length()
32
33### Fixes
34
351. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API
36
37## [0.3.0] - 2023-06-23
38
39### Added
40
411. Add encode/decode pldmMessagePollEvent data
422. README: Add a section on working with libpldm
433. pdr: Introduce remote_container_id and associated APIs
444. pdr: Add APIs for creating and locating remote PDRs
455. pdr: Add pldm_pdr_find_last_in_range()
466. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
477. pdr: Add pldm_pdr_find_container_id_range_exclude()
48
49### Changed
50
511. include: Move installed transport.h under libpldm/
522. libpldm: Explicit deprecated, stable and testing ABI classes
533. meson: Reduce strength of oem-ibm requirements from enabled to allowed
54
55   The `oem-ibm` feature is now enabled by the default meson configuration, for
56   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
57   recipe:
58
59   https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10
60
61   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
62   when invoking `meson setup`
63
644. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
655. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
66
67### Deprecated
68
691. bios_table: Deprecate APIs with arguments sanitized using assert()
70
71   C provides enough foot-guns without us encoding them into library APIs.
72   Specifically, deprecate the following in favour of their `*_check()` variants
73   which ensure assertions won't fail or otherwise invoke UB:
74
75   - pldm_bios_table_string_entry_encode()
76   - pldm_bios_table_string_entry_decode_string()
77   - pldm_bios_table_attr_entry_enum_encode()
78   - pldm_bios_table_attr_entry_enum_decode_pv_num()
79   - pldm_bios_table_attr_entry_enum_decode_def_num()
80   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
81   - pldm_bios_table_attr_entry_string_encode()
82   - pldm_bios_table_attr_entry_string_decode_def_string_length()
83
84### Removed
85
861. libpldm: Remove the requester-api option
87
88### Fixed
89
901. requester: Make pldm_open() return existing fd
912. transport: Prevent sticking in waiting for response
923. transport: Match on response in pldm_transport_send_recv_msg()
934. requester: Add check before accessing hdr in pldm_recv()
945. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
95