xref: /openbmc/libpldm/CHANGELOG.md (revision 615344fc17299f80c7e5e489b424ce0c480227dd)
16fd81a51SAndrew Jeffery# Changelog
26fd81a51SAndrew Jeffery
36fd81a51SAndrew JefferyAll notable changes to this project will be documented in this file.
46fd81a51SAndrew Jeffery
56fd81a51SAndrew JefferyThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66fd81a51SAndrew Jefferyand this project adheres to
76fd81a51SAndrew Jeffery[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
86fd81a51SAndrew Jeffery
96fd81a51SAndrew JefferyChange categories:
106fd81a51SAndrew Jeffery
116fd81a51SAndrew Jeffery- Added
126fd81a51SAndrew Jeffery- Changed
136fd81a51SAndrew Jeffery- Deprecated
146fd81a51SAndrew Jeffery- Removed
156fd81a51SAndrew Jeffery- Fixed
166fd81a51SAndrew Jeffery- Security
176fd81a51SAndrew Jeffery
18*615344fcSAndrew Jeffery## [0.9.1] - 2024-09-07
19*615344fcSAndrew Jeffery
20*615344fcSAndrew Jeffery### Changed
21*615344fcSAndrew Jeffery
22*615344fcSAndrew Jeffery1. Moved evolutions intended for v0.9.0 into place
23*615344fcSAndrew Jeffery
24*615344fcSAndrew Jeffery   Evolutions for the release have been moved from `evolutions/current` to
25*615344fcSAndrew Jeffery   `evolutions/v0.9.1`. Library users can apply them to migrate off of
26*615344fcSAndrew Jeffery   deprecated APIs.
2739f88325SRashmica Gupta
28747a498eSAndrew Jeffery## [0.9.0] - 2024-09-07
29747a498eSAndrew Jeffery
300ee03b5bSThu Nguyen### Added
310ee03b5bSThu Nguyen
320ee03b5bSThu Nguyen1. base: Define macros for reserved TIDs
33b02e0e11SVarsha Kaverappa2. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr()
34b02e0e11SVarsha Kaverappa3. pdr: Add pldm_entity_association_pdr_create_new()
35e5469f54SThu Nguyen4. platform: Define macros for the responded transferflags
36274732fcSPavithra Barithaya5. pdr: Add pldm_pdr_get_terminus_handle() API
37dacfa354SThu Nguyen6. pdr: Add related decode_entity_auxiliary_names_pdr() APIs
38b6ef35b4SChris Wang7. fw_update: Add encode req & decode resp for get_downstream_fw_params
3902903038SThu Nguyen8. platform: Add decode_pldm_platform_cper_event() API
400a1be3cbSAndrew Jeffery9. decode_get_pdr_repository_info_resp_safe()
410a1be3cbSAndrew Jeffery
420a1be3cbSAndrew Jeffery   Replaces decode_get_pdr_repository_info_resp() as discussed in the
430a1be3cbSAndrew Jeffery   `Deprecated` section below
440a1be3cbSAndrew Jeffery
450a1be3cbSAndrew Jeffery10. decode_get_pdr_resp_safe()
460a1be3cbSAndrew Jeffery
470a1be3cbSAndrew Jeffery    Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section
480a1be3cbSAndrew Jeffery    below
490ee03b5bSThu Nguyen
5043cb4b5fSThu Nguyen### Changed
5143cb4b5fSThu Nguyen
5243cb4b5fSThu Nguyen1. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs
537739d123SThu Nguyen2. platform: Rework decode/encode_pldm_message_poll_event_data() APIs
54f874b383SThu Nguyen3. platform: Stabilise decode_pldm_message_poll_event_data() APIs
5590bbe6c0SAndrew Jeffery4. ABI break for decode_sensor_op_data()
5690bbe6c0SAndrew Jeffery
5790bbe6c0SAndrew Jeffery   Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused
5890bbe6c0SAndrew Jeffery   abi-compliance-checker to flag a change in the register containing the
5990bbe6c0SAndrew Jeffery   parameter `previous_op_state`.
6043cb4b5fSThu Nguyen
613559aa1fSThu Nguyen5. platform: Stabilise decode_pldm_platform_cper_event() API
623559aa1fSThu Nguyen
63d9b70ba7SAndrew Jeffery### Deprecated
64d9b70ba7SAndrew Jeffery
65e7f55113SAndrew Jeffery1. Rename and deprecate functions with the `_check` suffix
66d9b70ba7SAndrew Jeffery
67e7f55113SAndrew Jeffery   All library function return values always need to be checked. The `_check`
68e7f55113SAndrew Jeffery   suffix is redundant, so remove it. Migration to the non-deprecated
69e7f55113SAndrew Jeffery   equivalents without the `_check` suffix can be performed using
70e7f55113SAndrew Jeffery   `scripts/ apply-renames` and the [clang-rename][] configurations under
71e7f55113SAndrew Jeffery   `evolutions/`
72d9b70ba7SAndrew Jeffery
73e7f55113SAndrew Jeffery   The deprecated functions:
74e7f55113SAndrew Jeffery
75e7f55113SAndrew Jeffery   - `get_fru_record_by_option_check()`
76d8bb75cbSAndrew Jeffery   - `pldm_bios_table_append_pad_checksum_check()`
7746673f4aSAndrew Jeffery   - `pldm_bios_table_attr_entry_enum_decode_def_num_check()`
7882b4d3b4SAndrew Jeffery   - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()`
79b06882f1SAndrew Jeffery   - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()`
807126b1d2SAndrew Jeffery   - `pldm_bios_table_attr_entry_enum_encode_check()`
815347e279SAndrew Jeffery   - `pldm_bios_table_attr_entry_integer_encode_check()`
82c668ffceSAndrew Jeffery   - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()`
83f6be4933SAndrew Jeffery   - `pldm_bios_table_attr_entry_string_encode_check()`
8409004d6aSAndrew Jeffery   - `pldm_bios_table_attr_value_entry_encode_enum_check()`
85504dd17fSAndrew Jeffery   - `pldm_bios_table_attr_value_entry_encode_integer_check()`
861a3983ceSAndrew Jeffery   - `pldm_bios_table_attr_value_entry_encode_string_check()`
878c37ab36SAndrew Jeffery   - `pldm_bios_table_string_entry_decode_string_check()`
88e48fdd6eSAndrew Jeffery   - `pldm_bios_table_string_entry_encode_check()`
89d72ea4b8SAndrew Jeffery   - `pldm_entity_association_pdr_add_check()`
90aa49b71fSAndrew Jeffery   - `pldm_entity_association_pdr_add_from_node_check()`
91e7f55113SAndrew Jeffery   - `pldm_pdr_add_check()`
92e7f55113SAndrew Jeffery   - `pldm_pdr_add_fru_record_set_check()`
93d9b70ba7SAndrew Jeffery
94acb0681dSAndrew Jeffery[clang-rename]: https://clang.llvm.org/extra/clang-rename.html
95d9b70ba7SAndrew Jeffery
960a1be3cbSAndrew Jeffery2. `decode_get_pdr_repository_info_resp()`
970a1be3cbSAndrew Jeffery
980a1be3cbSAndrew Jeffery   Users should move to `decode_get_pdr_repository_info_resp_safe()` which
990a1be3cbSAndrew Jeffery   eliminates the opportunity for buffer overruns when extracting objects from
1000a1be3cbSAndrew Jeffery   the message.
1010a1be3cbSAndrew Jeffery
1020a1be3cbSAndrew Jeffery3. `decode_get_pdr_resp()`
1030a1be3cbSAndrew Jeffery
1040a1be3cbSAndrew Jeffery   Users should move to `decode_get_pdr_resp_safe()` which reduces the
1050a1be3cbSAndrew Jeffery   invocation tedium and improves memory safety over `decode_get_pdr_resp()`.
1060a1be3cbSAndrew Jeffery
107a1efaa2eSAndrew Jeffery### Removed
108a1efaa2eSAndrew Jeffery
109a1efaa2eSAndrew Jeffery1. IBM OEM header compatibility symlinks.
110a1efaa2eSAndrew Jeffery
111a1efaa2eSAndrew Jeffery   Anyone left using the deprecated paths can migrate using the coccinelle patch
112a1efaa2eSAndrew Jeffery   at `evolutions/current/oem-ibm-header-compat.cocci`.
113a1efaa2eSAndrew Jeffery
114e4240679SAndrew Jeffery### Fixed
115e4240679SAndrew Jeffery
116e4240679SAndrew Jeffery1. requester: instance-id: Release read lock on conflict
117e4240679SAndrew Jeffery
118c166dd5fSAndrew Jeffery## [0.8.0] - 2024-05-23
119c166dd5fSAndrew Jeffery
120acf22454SAndrew Jeffery### Added
121acf22454SAndrew Jeffery
122acf22454SAndrew Jeffery1. base: Provide pldm_msg_hdr_correlate_response()
123acf22454SAndrew Jeffery2. transport: af-mctp: Add pldm_transport_af_mctp_bind()
124499389ecSKamalkumar Patel3. oem: ibm: Add chapdata file type support
1256967fc73SManojkiran Eda4. base: Added PLDM_SMBIOS & PLDM_RDE message types
12622fad395SDelphine CC Chiu5. oem: meta: Add decode_oem_meta_file_io_req()
12739aa036eSVarsha Kaverappa6. state-set: Add all state set values to system power state enum as per DSP0249
1280ee77664SVarsha Kaverappa7. platform: Add alias members to the enum
1290ee77664SVarsha Kaverappa   pldm_pdr_repository_chg_event_change_record_event_data_operation.
1300ee77664SVarsha Kaverappa
1310ee77664SVarsha Kaverappa   enum constants with inconsistent names are deprecated with this change.
1320ee77664SVarsha Kaverappa   remove old inconsistent enum members after backward compatibility cleanup is
1330ee77664SVarsha Kaverappa   done
134acf22454SAndrew Jeffery
135a9f2ffd4SPavithra Barithaya8. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*`
136819f138aSPavithra Barithaya9. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type
13764764fd6SJinliang Wang10. platform: Add 3 PDR type enum for Redfish Device Enablement per
13864764fd6SJinliang Wang    DSP0248_1.2.0
13964764fd6SJinliang Wang11. state_set: Add CONNECTED and DISCONNECTED enum for Link State set
14064764fd6SJinliang Wang12. entity: Add enum for Network Interface Connectors and Network Ports
14164764fd6SJinliang Wang    Connection Types
142d4878cdfSThu Nguyen13. pdr: Add decode_numeric_effecter_pdr_data()
143ea435c9fSJayashankar Padath14. oem: ibm: Support for the Real SAI entity id
1444c1f2c72SChris Wang15. fw_update: Add encode req & decode resp for query_downstream_devices
145458475a9SChris Wang16. fw_update: Add encode req & decode resp for query_downstream_identifiers
146a6fa5559STal Yacobi17. platform: Add support for GetStateEffecterStates command
147a9f2ffd4SPavithra Barithaya
148acf22454SAndrew Jeffery### Changed
149acf22454SAndrew Jeffery
150acf22454SAndrew Jeffery1. base: Stabilise pldm_msg_hdr_correlate_response()
151acf22454SAndrew Jeffery2. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind()
152b0c1d20aSAndrew Jeffery3. libpldm: Fix header use
153efb40069SAndrew Jeffery4. libpldm: More fixes for header use
1544a307bcaSPavithra Barithaya5. pdr: Stabilise pldm_pdr_find_last_in_range() API
1553a267059SPavithra Barithaya6. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle()
156a98814fcSAndrew Jeffery7. oem: meta: stabilise decode_oem_meta_file_io_req()
157c6c391d6SGeorge Liu8. pdr: pldm_entity_association_tree_copy_root(): Document preconditions
158acf22454SAndrew Jeffery
159a9f2ffd4SPavithra Barithaya### Deprecated
160a9f2ffd4SPavithra Barithaya
161a9f2ffd4SPavithra Barithaya1. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed
162a9f2ffd4SPavithra Barithaya   with `PLDM_OEM_IBM_`
163a9f2ffd4SPavithra Barithaya
164d12dd36eSAndrew Jeffery### Fixed
165d12dd36eSAndrew Jeffery
166d12dd36eSAndrew Jeffery1. libpldm: Rationalise the local and installed path of pldm.h
16739eb3224SPavithra Barithaya2. pdr: Assign record_handle in entity_association_pdr_add_children()
168cd07fec7SThu Nguyen3. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value()
16951230a0aSThu Nguyen4. pdr: Remove redundant constant for minimum numeric sensor PDR length
17032df16c4SAndrew Jeffery5. tests: oem: meta: Fix fileio use of msgbuf
171d12dd36eSAndrew Jeffery
1723f39f963SAndrew Jeffery## [0.7.0] - 2023-08-29
1733f39f963SAndrew Jeffery
174f37e4dc8SPavithra Barithaya### Added
175f37e4dc8SPavithra Barithaya
176f37e4dc8SPavithra Barithaya1. state-set: Add new enum for Operational Fault Status enum
1776c835a14SAndrew Jeffery
1786c835a14SAndrew Jeffery### Changed
1796c835a14SAndrew Jeffery
1806c835a14SAndrew Jeffery1. transport: Match specified metadata in pldm_transport_send_recv_msg()
18145816b89SAndrew Jeffery2. transport: mctp-demux: Drop ABI annotation for internal symbols
1820a6d6821SAndrew Jeffery3. transport: Stabilise core transport and implementation APIs
1830a6d6821SAndrew Jeffery
1840a6d6821SAndrew Jeffery   This stabilisation covers the following headers and functions:
1850a6d6821SAndrew Jeffery
1860a6d6821SAndrew Jeffery   - libpldm/transport.h
1870a6d6821SAndrew Jeffery
1880a6d6821SAndrew Jeffery     - pldm_transport_poll()
1890a6d6821SAndrew Jeffery     - pldm_transport_send_msg()
1900a6d6821SAndrew Jeffery     - pldm_transport_recv_msg()
1910a6d6821SAndrew Jeffery     - pldm_transport_send_recv_msg()
1920a6d6821SAndrew Jeffery
1930a6d6821SAndrew Jeffery   - libpldm/transport/af-mctp.h
1940a6d6821SAndrew Jeffery
1950a6d6821SAndrew Jeffery     - pldm_transport_af_mctp_init()
1960a6d6821SAndrew Jeffery     - pldm_transport_af_mctp_destroy()
1970a6d6821SAndrew Jeffery     - pldm_transport_af_mctp_core()
1980a6d6821SAndrew Jeffery     - pldm_transport_af_mctp_init_pollfd()
1990a6d6821SAndrew Jeffery     - pldm_transport_af_mctp_map_tid()
2000a6d6821SAndrew Jeffery     - pldm_transport_af_mctp_unmap_tid()
2010a6d6821SAndrew Jeffery
2020a6d6821SAndrew Jeffery   - libpldm/transport/mctp-demux.h
2030a6d6821SAndrew Jeffery     - pldm_transport_mctp_demux_init()
2040a6d6821SAndrew Jeffery     - pldm_transport_mctp_demux_destroy()
2050a6d6821SAndrew Jeffery     - pldm_transport_mctp_demux_core()
2060a6d6821SAndrew Jeffery     - pldm_transport_mctp_demux_init_pollfd()
2070a6d6821SAndrew Jeffery     - pldm_transport_mctp_demux_map_tid()
2080a6d6821SAndrew Jeffery     - pldm_transport_mctp_demux_unmap_tid()
2090a6d6821SAndrew Jeffery
2100a6d6821SAndrew Jeffery### Deprecated
2110a6d6821SAndrew Jeffery
2120a6d6821SAndrew Jeffery1. All the existing "requester" APIs from `libpldm/pldm.h` (also known as
2130a6d6821SAndrew Jeffery   `libpldm/requester/pldm.h`):
2140a6d6821SAndrew Jeffery
2150a6d6821SAndrew Jeffery   - pldm_open()
2160a6d6821SAndrew Jeffery   - pldm_send_recv()
2170a6d6821SAndrew Jeffery   - pldm_send()
2180a6d6821SAndrew Jeffery   - pldm_recv()
2190a6d6821SAndrew Jeffery   - pldm_recv_any()
2200a6d6821SAndrew Jeffery   - pldm_close()
2210a6d6821SAndrew Jeffery
2220a6d6821SAndrew Jeffery   Users should migrate to the newer "transport" APIs instead.
223f37e4dc8SPavithra Barithaya
224ba05dba7SAndrew Jeffery## Fixed
225ba05dba7SAndrew Jeffery
226ba05dba7SAndrew Jeffery1. tests: Exclude transport tests when build excludes testing ABIs
22734ac891fSAndrew Jeffery2. abi: Capture deprecation of pldm_close()
228ba05dba7SAndrew Jeffery
229d2a36a16SAndrew Jeffery## [0.6.0] - 2023-08-22
230d2a36a16SAndrew Jeffery
2317062382aSAndrew Jeffery### Changed
2327062382aSAndrew Jeffery
2337062382aSAndrew Jeffery1. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity()
2345cf32ea8SAndrew Jeffery2. meson: Apply `b_ndebug=if-release` by default
235e7eebe33SAndrew Jeffery3. pdr : Stabilize pldm_entity_association_tree_add_entity()
23675ce90a5SAndrew Jeffery4. pdr: Stabilise pldm_entity_association_tree_find_with_locality()
237def8e024SPavithra Barithaya5. pdr: Stabilize pldm_entity_node_get_remote_container_id()
238ac24737cSAndrew Jeffery6. transport: af-mctp: Assign out-params on success in \*\_recv()
23924576290SRashmica Gupta7. transport: Generalise the pldm_transport_recv_msg() API
2407062382aSAndrew Jeffery
241255f6549SAndrew Jeffery### Removed
242255f6549SAndrew Jeffery
243255f6549SAndrew Jeffery1. pdr: Remove pldm_entity_association_pdr_add()
2447e3c9e4dSPavithra Barithaya2. state-set: Remove enum pldm_state_set_operational_fault_status_values
245255f6549SAndrew Jeffery
246b4cd5172SDelphine CC Chiu### Fixed
247b4cd5172SDelphine CC Chiu
248b4cd5172SDelphine CC Chiu1. transport: register init_pollfd callback for af-mctp
24936402ffbSBonnieLo-wiwynn2. transport: fix init_pollfd function parameter
250f1ebde49SRashmica Gupta3. transport: Fix doxygen and variables for send and recv functions
2517caa8af1SAndrew Jeffery4. transport: af-mctp: Ensure malloc() succeeds in \*\_recv()
252b4cd5172SDelphine CC Chiu
25320cc060cSAndrew Jeffery## [0.5.0] - 2023-08-09
25420cc060cSAndrew Jeffery
25565945992SAndrew Jeffery### Added
25665945992SAndrew Jeffery
25765945992SAndrew Jeffery1. pdr: Introduce pldm_entity_association_pdr_add_check()
25865945992SAndrew Jeffery
2593b93d09cSAndrew Jeffery### Changed
2603b93d09cSAndrew Jeffery
2613b93d09cSAndrew Jeffery1. pdr: Allow record_handle to be NULL for pldm_pdr_add_check()
2623380a6c6SAndrew Jeffery2. transport: pldm_transport_poll(): Adjust return value semantics
263f56e4dcdSThu Nguyen3. transport: free un-wanted responses in pldm_transport_send_recv_msg()
2643b93d09cSAndrew Jeffery
2658bcbe251SAndrew Jeffery### Deprecated
2668bcbe251SAndrew Jeffery
2678bcbe251SAndrew Jeffery1. state-set: Enum pldm_state_set_operational_fault_status_values
2688bcbe251SAndrew Jeffery
2698bcbe251SAndrew Jeffery   The enum operational_fault_status is defined with wrong members and will
2708bcbe251SAndrew Jeffery   eventually be replaced with the correct members. Any uses of
2718bcbe251SAndrew Jeffery   pldm_state_set_operational_fault_status_values members should move to
2728bcbe251SAndrew Jeffery   equivalent pldm_state_set_operational_stress_status_values members if needed.
2738bcbe251SAndrew Jeffery
2748bcbe251SAndrew Jeffery2. platform: Struct field name in fru_record_set PDR
2758bcbe251SAndrew Jeffery
2768bcbe251SAndrew Jeffery   References to entity_instance_num should be changed to entity_instance
2778bcbe251SAndrew Jeffery
2788bcbe251SAndrew Jeffery3. platform: Struct field name in numeric sensor value PDR
2798bcbe251SAndrew Jeffery
2808bcbe251SAndrew Jeffery   References to entity_instance_num should be changed to entity_instance
2818bcbe251SAndrew Jeffery
2820ecf6bcfSAndrew Jeffery### Removed
2830ecf6bcfSAndrew Jeffery
2840ecf6bcfSAndrew Jeffery1. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length()
2858b1c0340SAndrew Jeffery2. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum()
28646d07685SAndrew Jeffery3. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string()
2874e1f131cSAndrew Jeffery4. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer()
28850dd159eSAndrew Jeffery5. bios_table: Remove pldm_bios_table_append_pad_checksum()
2898810feceSAndrew Jeffery6. fru: Remove get_fru_record_by_option()
290d09b1af0SAndrew Jeffery7. pdr: Make is_present() static
291c79a5df5SAndrew Jeffery8. pdr: Remove pldm_pdr_add()
29214d2984bSAndrew Jeffery9. pdr: Remove pldm_pdr_add_fru_record_set()
2938985dfd1SAndrew Jeffery10. pdr: Remove pldm_entity_association_pdr_add_from_node()
294643c443bSAndrew Jeffery11. pdr: Make find_entity_ref_in_tree() static
29554d91e81SAndrew Jeffery12. pdr: Make entity_association_tree_find() static
2960ecf6bcfSAndrew Jeffery
29743a7985dSThu Nguyen### Fixed
29843a7985dSThu Nguyen
29943a7985dSThu Nguyen1. requester: Fix response buffer cast in pldm_send_recv()
300c6cc028fSAndrew Jeffery2. pdr: Hoist record handle overflow test to avoid memory leak
301ef485068SThu Nguyen3. transport: Correct comparison in while loop condition
30243a7985dSThu Nguyen
3038a4b5336SAndrew Jeffery## [0.4.0] - 2023-07-14
3048a4b5336SAndrew Jeffery
305044ee19aSAndrew Jeffery### Added
306044ee19aSAndrew Jeffery
307044ee19aSAndrew Jeffery1. bios_table: Introduce pldm_bios_table_append_pad_checksum_check()
3087cd16ff8SAndrew Jeffery2. fru: Introduce get_fru_record_by_option_check()
309cc394529SAndrew Jeffery3. pdr: Introduce pldm_entity_association_pdr_add_from_node_check()
310572a3950SAndrew Jeffery4. pdr: Introduce pldm_pdr_add_check()
311c821a700SAndrew Jeffery5. pdr: Introduce pldm_pdr_add_fru_record_set_check()
312044ee19aSAndrew Jeffery
313986df2a1SAndrew Jeffery### Changed
314986df2a1SAndrew Jeffery
315986df2a1SAndrew Jeffery1. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING
3165fb9680bSAndrew Jeffery2. requester: Expose pldm_close() in header
317a873eca0SAndrew Jeffery3. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow
318757e81a1SAndrew Jeffery4. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc
31973d9176aSAndrew Jeffery5. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration
320a8bb22edSAndrew Jeffery6. pdr: pldm_pdr_init(): Return NULL on allocation failure
321fca1b60fSAndrew Jeffery7. pdr: pldm_pdr_destroy(): Exit early if repo is NULL
3225565fcdeSAndrew Jeffery8. pdr: Document preconditions for trivial accessor functions
3235565fcdeSAndrew Jeffery
3245565fcdeSAndrew Jeffery   A trivial accessor function is one that exposes properties of an object in a
3255565fcdeSAndrew Jeffery   way can't result in an error, beyond passing an invalid argument to the
3265565fcdeSAndrew Jeffery   function. For APIs meeting this definition we define a precondition that
3275565fcdeSAndrew Jeffery   struct pointers must point to valid objects to avoid polluting the function
3285565fcdeSAndrew Jeffery   prototypes. The following APIs now have this precondition explicitly defined:
3295565fcdeSAndrew Jeffery
3305565fcdeSAndrew Jeffery   - pldm_entity_extract()
3315565fcdeSAndrew Jeffery   - pldm_entity_get_parent()
3325565fcdeSAndrew Jeffery   - pldm_entity_is_exist_parent()
3335565fcdeSAndrew Jeffery   - pldm_entity_is_node_parent()
3345565fcdeSAndrew Jeffery   - pldm_is_current_parent_child
3355565fcdeSAndrew Jeffery   - pldm_is_empty_entity_assoc_tree()
3365565fcdeSAndrew Jeffery   - pldm_pdr_get_record_count()
3375565fcdeSAndrew Jeffery   - pldm_pdr_get_record_handle()
3385565fcdeSAndrew Jeffery   - pldm_pdr_get_repo_size()
3395565fcdeSAndrew Jeffery   - pldm_pdr_record_is_remote()
340986df2a1SAndrew Jeffery
34115b8818cSAndrew Jeffery9. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor
34201425e96SAndrew Jeffery10. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments
343c40037d5SAndrew Jeffery11. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc
3448e9b0de8SAndrew Jeffery12. pdr: pldm_entity_association_tree_visit(): Document preconditions
345cd17e5ccSAndrew Jeffery13. pdr: pldm_entity_association_tree_visit(): Exit early on failure
346a89e015cSAndrew Jeffery14. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument
3476e8a2617SAndrew Jeffery15. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments
348375d9fc1SAndrew Jeffery16. pdr: pldm_is_current_parent_child(): Return false for invalid arguments
349c788348eSAndrew Jeffery17. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments
350ba47e83eSAndrew Jeffery18. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments
35194e364dbSAndrew Jeffery19. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments
35285d7a056SAndrew Jeffery20. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg
3533a5c46b4SAndrew Jeffery21. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments
3540dbaa70fSAndrew Jeffery22. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit
355c83ef86dSAndrew Jeffery23. pdr: pldm_entity_get_num_children(): Don't return invalid values
3568526892fSAndrew Jeffery24. libpldm: Lift or remove asserts where a subsequent check exists
35715b8818cSAndrew Jeffery
358fe0f01d8SAndrew Jeffery### Deprecated
359fe0f01d8SAndrew Jeffery
360fe0f01d8SAndrew Jeffery1. pldm_bios_table_attr_entry_integer_encode()
361fe0f01d8SAndrew Jeffery
362fe0f01d8SAndrew Jeffery   Migrate to pldm_bios_table_attr_entry_integer_encode_check()
363fe0f01d8SAndrew Jeffery
3647aeb7edbSAndrew Jeffery2. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum()
3657aeb7edbSAndrew Jeffery
3667aeb7edbSAndrew Jeffery   Migrate to pldm_bios_table_attr_value_entry_encode_enum_check()
3677aeb7edbSAndrew Jeffery
3682d66393fSAndrew Jeffery3. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string()
3692d66393fSAndrew Jeffery
3702d66393fSAndrew Jeffery   Migrate to pldm_bios_table_attr_value_entry_encode_string_check()
3712d66393fSAndrew Jeffery
3720088a6aeSAndrew Jeffery4. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer()
3730088a6aeSAndrew Jeffery
3740088a6aeSAndrew Jeffery   Migrate to pldm_bios_table_attr_value_entry_encode_integer_check()
3750088a6aeSAndrew Jeffery
376d11bf9f7SAndrew Jeffery5. pdr: Deprecate is_present()
377d11bf9f7SAndrew Jeffery
378d11bf9f7SAndrew Jeffery   There should be no users of this symbol. If you are a user, you should figure
379d11bf9f7SAndrew Jeffery   out how to stop, or get in touch. This symbol will be marked static the
380d11bf9f7SAndrew Jeffery   release after deprecation.
381d11bf9f7SAndrew Jeffery
382bfeb65ebSAndrew Jeffery6. pdr: Deprecate find_entity_ref_in_tree()
383bfeb65ebSAndrew Jeffery
384bfeb65ebSAndrew Jeffery   There should be no users of this symbol. If you are a user, you should figure
385bfeb65ebSAndrew Jeffery   out how to stop, or get in touch. This symbol will be marked static the
386bfeb65ebSAndrew Jeffery   release after deprecation.
387bfeb65ebSAndrew Jeffery
3887f589313SAndrew Jeffery7. pdr: Deprecate entity_association_tree_find()
3897f589313SAndrew Jeffery
3907f589313SAndrew Jeffery   There should be no users of this symbol. If you are a user, you should figure
3917f589313SAndrew Jeffery   out how to stop, or get in touch. This symbol will be marked static the
3927f589313SAndrew Jeffery   release after deprecation.
3937f589313SAndrew Jeffery
3941264fbd9SAndrew Jeffery8. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check()
3951264fbd9SAndrew Jeffery
3961264fbd9SAndrew Jeffery   pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of
3971264fbd9SAndrew Jeffery   pldm_bios_table_append_pad_checksum() should migrate to
3981264fbd9SAndrew Jeffery   pldm_bios_table_append_pad_checksum_check()
3991264fbd9SAndrew Jeffery
400962fcec7SAndrew Jeffery9. fru: Stabilise get_fru_record_by_option_check()
401962fcec7SAndrew Jeffery
402962fcec7SAndrew Jeffery   get_fru_record_by_option() is deprecated by this change. Users of
403962fcec7SAndrew Jeffery   get_fru_record_by_option() should migrate to get_fru_record_by_option_check()
404962fcec7SAndrew Jeffery
4051354a6eeSAndrew Jeffery10. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check()
4061354a6eeSAndrew Jeffery
4071354a6eeSAndrew Jeffery    pldm_entity_association_pdr_add_from_node() is deprecated by this change.
4081354a6eeSAndrew Jeffery    Users of pldm_entity_association_pdr_add_from_node() should migrate to
4091354a6eeSAndrew Jeffery    pldm_entity_association_pdr_add_from_node_check()
4101354a6eeSAndrew Jeffery
411ca248ce3SAndrew Jeffery11. pdr: Stabilise pldm_pdr_add_check()
412ca248ce3SAndrew Jeffery
413ca248ce3SAndrew Jeffery    pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should
414ca248ce3SAndrew Jeffery    migrate to pldm_pdr_add_check()
415ca248ce3SAndrew Jeffery
416a2c69117SAndrew Jeffery12. pdr: Stabilise pldm_pdr_add_fru_record_set_check()
417a2c69117SAndrew Jeffery
418a2c69117SAndrew Jeffery    pldm_pdr_add_fru_record_set() is deprecated by this change. Users of
419a2c69117SAndrew Jeffery    pldm_pdr_add_fru_record_set() should migrate to
420a2c69117SAndrew Jeffery    pldm_pdr_add_fru_record_set_check()
421a2c69117SAndrew Jeffery
4226409c8a0SAndrew Jeffery### Removed
4236409c8a0SAndrew Jeffery
4246409c8a0SAndrew Jeffery1. bios_table: Remove deprecated APIs sanitized by assert():
4256409c8a0SAndrew Jeffery
4266409c8a0SAndrew Jeffery   - pldm_bios_table_string_entry_encode()
4276409c8a0SAndrew Jeffery   - pldm_bios_table_string_entry_decode_string()
4286409c8a0SAndrew Jeffery   - pldm_bios_table_attr_entry_enum_encode()
4296409c8a0SAndrew Jeffery   - pldm_bios_table_attr_entry_enum_decode_pv_num()
4306409c8a0SAndrew Jeffery   - pldm_bios_table_attr_entry_enum_decode_def_num()
4316409c8a0SAndrew Jeffery   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
4326409c8a0SAndrew Jeffery   - pldm_bios_table_attr_entry_string_encode()
4336409c8a0SAndrew Jeffery   - pldm_bios_table_attr_entry_string_decode_def_string_length()
4346409c8a0SAndrew Jeffery
43509778a82SAndrew Jeffery### Fixed
436ffd5342cSPavithra Barithaya
437ffd5342cSPavithra Barithaya1. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API
4388cf70456SPavithra Barithaya2. pdr: Rework pldm_pdr_find_container_id_range_exclude() API
439a4da6858SAndrew Jeffery3. transport: mctp-demux: Don't test socket for non-zero value
4404e1ba8a7SAndrew Jeffery4. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error
441af7a4d82SAndrew Jeffery5. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return
442178531a0SRashmica Gupta6. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init()
443cd732d14SAndrew Jeffery7. abi: Update to remove pldm_close() from reference dumps
4449e33be96SAndrew Jeffery8. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer()
445ffd5342cSPavithra Barithaya
446291da195SAndrew Jeffery## [0.3.0] - 2023-06-23
447291da195SAndrew Jeffery
4487c250340SDung Cao### Added
4497c250340SDung Cao
4507c250340SDung Cao1. Add encode/decode pldmMessagePollEvent data
45183841fb5SAndrew Jeffery2. README: Add a section on working with libpldm
45239bd2ea5SArchanaKakani3. pdr: Introduce remote_container_id and associated APIs
4539947f9d6SPavithra Barithaya4. pdr: Add APIs for creating and locating remote PDRs
4544d694346SPavithra Barithaya5. pdr: Add pldm_pdr_find_last_in_range()
45525ddbccfSPavithra Barithaya6. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
4565dc02571SPavithra Barithaya7. pdr: Add pldm_pdr_find_container_id_range_exclude()
4577c250340SDung Cao
458b443b487SRashmica Gupta### Changed
459b443b487SRashmica Gupta
460b443b487SRashmica Gupta1. include: Move installed transport.h under libpldm/
46183841fb5SAndrew Jeffery2. libpldm: Explicit deprecated, stable and testing ABI classes
4628de8e1ecSAndrew Jeffery3. meson: Reduce strength of oem-ibm requirements from enabled to allowed
4638de8e1ecSAndrew Jeffery
4648de8e1ecSAndrew Jeffery   The `oem-ibm` feature is now enabled by the default meson configuration, for
4658de8e1ecSAndrew Jeffery   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
4668de8e1ecSAndrew Jeffery   recipe:
4678de8e1ecSAndrew Jeffery
4680f7218cdSGeorge Liu   <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10>
4698de8e1ecSAndrew Jeffery
4708de8e1ecSAndrew Jeffery   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
4718de8e1ecSAndrew Jeffery   when invoking `meson setup`
472b443b487SRashmica Gupta
47398c1e69dSAndrew Jeffery4. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
4740c9f5a8aSAndrew Jeffery5. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
47598c1e69dSAndrew Jeffery
476d47e8ab8SAndrew Jeffery### Deprecated
477d47e8ab8SAndrew Jeffery
478d47e8ab8SAndrew Jeffery1. bios_table: Deprecate APIs with arguments sanitized using assert()
479d47e8ab8SAndrew Jeffery
480d47e8ab8SAndrew Jeffery   C provides enough foot-guns without us encoding them into library APIs.
481d47e8ab8SAndrew Jeffery   Specifically, deprecate the following in favour of their `*_check()` variants
482d47e8ab8SAndrew Jeffery   which ensure assertions won't fail or otherwise invoke UB:
483d47e8ab8SAndrew Jeffery
484d47e8ab8SAndrew Jeffery   - pldm_bios_table_string_entry_encode()
485d47e8ab8SAndrew Jeffery   - pldm_bios_table_string_entry_decode_string()
486d47e8ab8SAndrew Jeffery   - pldm_bios_table_attr_entry_enum_encode()
487d47e8ab8SAndrew Jeffery   - pldm_bios_table_attr_entry_enum_decode_pv_num()
488d47e8ab8SAndrew Jeffery   - pldm_bios_table_attr_entry_enum_decode_def_num()
489d47e8ab8SAndrew Jeffery   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
490d47e8ab8SAndrew Jeffery   - pldm_bios_table_attr_entry_string_encode()
491d47e8ab8SAndrew Jeffery   - pldm_bios_table_attr_entry_string_decode_def_string_length()
492d47e8ab8SAndrew Jeffery
4934b4603b3SAndrew Jeffery### Removed
4944b4603b3SAndrew Jeffery
4954b4603b3SAndrew Jeffery1. libpldm: Remove the requester-api option
4964b4603b3SAndrew Jeffery
49739f88325SRashmica Gupta### Fixed
49839f88325SRashmica Gupta
49939f88325SRashmica Gupta1. requester: Make pldm_open() return existing fd
500abaf61f4SDung Cao2. transport: Prevent sticking in waiting for response
501b01fb1ccSThu Nguyen3. transport: Match on response in pldm_transport_send_recv_msg()
502a3035938SRashmica Gupta4. requester: Add check before accessing hdr in pldm_recv()
503df02e360SAndrew Jeffery5. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
504