xref: /openbmc/libpldm/CHANGELOG.md (revision 82c348150f56dbd8c94a08c0e5ab99ccd165ad26)
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### Added
21
221. oem: meta: Add decode_oem_meta_file_io_write_req()
232. oem: meta: Add decode_oem_meta_file_io_read_req()
243. oem: meta: Add encode_oem_meta_file_io_read_resp()
254. pdr: Add pldm_entity_association_pdr_remove_contained_entity()
265. pdr: Add pldm_pdr_remove_fru_record_set_by_rsi()
276. pldm_entity_association_tree_copy_root_check()
287. oem: ibm: Add topology related state set and enum
29
308. base: Add size and buffer macros for struct pldm_msg
31
32   Together these macros reduce the need for use of reinterpret_cast<>() in C++.
33
34### Changed
35
361. dsp: bios_table: Null check for pldm_bios_table_iter_is_end()
37
38   pldm_bios_table_iter_is_end() now returns true if the provided argument is
39   NULL.
40
412. Register assignment for parameters of a number of APIs changed with increased
42   scrutiny on their implementations.
43
44   - `decode_entity_auxiliary_names_pdr()`
45   - `decode_get_state_sensor_readings_resp()`
46   - `decode_platform_event_message_req()`
47   - `decode_platform_event_message_resp()`
48   - `decode_sensor_op_data()`
49   - `encode_get_state_effecter_states_resp()`
50   - `encode_state_effecter_pdr()`
51   - `encode_state_sensor_pdr()`
52   - `pldm_bios_table_append_pad_checksum()`
53   - `pldm_bios_table_attr_value_entry_encode_enum()`
54   - `pldm_bios_table_attr_value_entry_encode_string()`
55   - `pldm_pdr_find_record()`
56   - `pldm_pdr_get_next_record()`
57
583. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req()
59
604. dsp: firmware_update: Bounds check
61   decode_downstream_device_parameter_table_entry_versions()
62
63   The additional bounds-checking required the addition of further length
64   parameters.
65
66### Deprecated
67
681. oem: meta: Deprecate `decode_oem_meta_file_io_req()`
69
70   Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this
71   function to make it safer.
72
73   Modification:
74
75   - The meaning of the returned result.
76   - Change parameters from individual pointers to a struct.
77   - Check the length provided in the message won't exceed the buffer.
78
792. pldm_entity_association_tree_copy_root()
80
81   The implementation allocates, but gives no indication to the caller if an
82   allocation (and hence the copy) has failed. Users should migrate to
83   pldm_entity_association_tree_copy_root_check().
84
85### Removed
86
871. Deprecated functions with the `_check` suffix
88
89   - `get_fru_record_by_option_check()`
90   - `pldm_bios_table_append_pad_checksum_check()`
91   - `pldm_bios_table_attr_entry_enum_decode_def_num_check()`
92   - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()`
93   - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()`
94   - `pldm_bios_table_attr_entry_enum_encode_check()`
95   - `pldm_bios_table_attr_entry_integer_encode_check()`
96   - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()`
97   - `pldm_bios_table_attr_entry_string_encode_check()`
98   - `pldm_bios_table_attr_value_entry_encode_enum_check()`
99   - `pldm_bios_table_attr_value_entry_encode_integer_check()`
100   - `pldm_bios_table_attr_value_entry_encode_string_check()`
101   - `pldm_bios_table_string_entry_decode_string_check()`
102   - `pldm_bios_table_string_entry_encode_check()`
103   - `pldm_entity_association_pdr_add_check()`
104   - `pldm_entity_association_pdr_add_from_node_check()`
105   - `pldm_pdr_add_check()`
106   - `pldm_pdr_add_fru_record_set_check()`
107
108### Fixed
109
1101. dsp: bios_table: Null check for pldm_bios_table_iter_is_end()
111
112   Avoid a caller-controlled NULL pointer dereference in the library
113   implementation.
114
1152. platform: fix encode/decode_poll_for_platform_event_message_req
116
117   Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to
118   follow spec.
119
1203. platform: Fix checking `eventIDToAcknowledge`
121
122   As the event receiver sends `PollForPlatformEventMessage` with the
123   `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge`
124   should be the previously retrieved eventID (from the PLDM terminus).
125
1264. dsp: platform: Prevent overflow of arithmetic on event_data_length
1275. dsp: platform: Bounds check encode_sensor_state_pdr()
1286. dsp: platform: Bounds check encode_state_effecter_pdr()
1297. dsp: pdr: Bounds check pldm_entity_association_pdr_extract()
1308. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum()
1319. dsp: bios_table: Bounds check
132   pldm_bios_table_attr_value_entry_encode_string()
13310. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum()
13411. dsp: firmware_update: Bounds check
135    decode_downstream_device_parameter_table_entry_versions()
13612. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req()
13713. dsp: fru: Bounds check encode_get_fru_record_by_option_resp()
138
139## [0.9.1] - 2024-09-07
140
141### Changed
142
1431. Moved evolutions intended for v0.9.0 into place
144
145   Evolutions for the release have been moved from `evolutions/current` to
146   `evolutions/v0.9.1`. Library users can apply them to migrate off of
147   deprecated APIs.
148
149## [0.9.0] - 2024-09-07
150
151### Added
152
1531. base: Define macros for reserved TIDs
1542. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr()
1553. pdr: Add pldm_entity_association_pdr_create_new()
1564. platform: Define macros for the responded transferflags
1575. pdr: Add pldm_pdr_get_terminus_handle() API
1586. pdr: Add related decode_entity_auxiliary_names_pdr() APIs
1597. fw_update: Add encode req & decode resp for get_downstream_fw_params
1608. platform: Add decode_pldm_platform_cper_event() API
1619. decode_get_pdr_repository_info_resp_safe()
162
163   Replaces decode_get_pdr_repository_info_resp() as discussed in the
164   `Deprecated` section below
165
16610. decode_get_pdr_resp_safe()
167
168    Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section
169    below
170
171### Changed
172
1731. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs
1742. platform: Rework decode/encode_pldm_message_poll_event_data() APIs
1753. platform: Stabilise decode_pldm_message_poll_event_data() APIs
1764. ABI break for decode_sensor_op_data()
177
178   Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused
179   abi-compliance-checker to flag a change in the register containing the
180   parameter `previous_op_state`.
181
1825. platform: Stabilise decode_pldm_platform_cper_event() API
1836. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API
1847. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API
1858. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API
186
187### Deprecated
188
1891. Rename and deprecate functions with the `_check` suffix
190
191   All library function return values always need to be checked. The `_check`
192   suffix is redundant, so remove it. Migration to the non-deprecated
193   equivalents without the `_check` suffix can be performed using
194   `scripts/ apply-renames` and the [clang-rename][] configurations under
195   `evolutions/`
196
197   The deprecated functions:
198
199   - `get_fru_record_by_option_check()`
200   - `pldm_bios_table_append_pad_checksum_check()`
201   - `pldm_bios_table_attr_entry_enum_decode_def_num_check()`
202   - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()`
203   - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()`
204   - `pldm_bios_table_attr_entry_enum_encode_check()`
205   - `pldm_bios_table_attr_entry_integer_encode_check()`
206   - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()`
207   - `pldm_bios_table_attr_entry_string_encode_check()`
208   - `pldm_bios_table_attr_value_entry_encode_enum_check()`
209   - `pldm_bios_table_attr_value_entry_encode_integer_check()`
210   - `pldm_bios_table_attr_value_entry_encode_string_check()`
211   - `pldm_bios_table_string_entry_decode_string_check()`
212   - `pldm_bios_table_string_entry_encode_check()`
213   - `pldm_entity_association_pdr_add_check()`
214   - `pldm_entity_association_pdr_add_from_node_check()`
215   - `pldm_pdr_add_check()`
216   - `pldm_pdr_add_fru_record_set_check()`
217
218[clang-rename]: https://clang.llvm.org/extra/clang-rename.html
219
2202. `decode_get_pdr_repository_info_resp()`
221
222   Users should move to `decode_get_pdr_repository_info_resp_safe()` which
223   eliminates the opportunity for buffer overruns when extracting objects from
224   the message.
225
2263. `decode_get_pdr_resp()`
227
228   Users should move to `decode_get_pdr_resp_safe()` which reduces the
229   invocation tedium and improves memory safety over `decode_get_pdr_resp()`.
230
231### Removed
232
2331. IBM OEM header compatibility symlinks.
234
235   Anyone left using the deprecated paths can migrate using the coccinelle patch
236   at `evolutions/current/oem-ibm-header-compat.cocci`.
237
238### Fixed
239
2401. requester: instance-id: Release read lock on conflict
2412. pdr: Error propagation for
242   pldm_entity_association_pdr_add_from_node_with_record_handle()
243
244## [0.8.0] - 2024-05-23
245
246### Added
247
2481. base: Provide pldm_msg_hdr_correlate_response()
2492. transport: af-mctp: Add pldm_transport_af_mctp_bind()
2503. oem: ibm: Add chapdata file type support
2514. base: Added PLDM_SMBIOS & PLDM_RDE message types
2525. oem: meta: Add decode_oem_meta_file_io_req()
2536. state-set: Add all state set values to system power state enum as per DSP0249
2547. platform: Add alias members to the enum
255   pldm_pdr_repository_chg_event_change_record_event_data_operation.
256
257   enum constants with inconsistent names are deprecated with this change.
258   remove old inconsistent enum members after backward compatibility cleanup is
259   done
260
2618. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*`
2629. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type
26310. platform: Add 3 PDR type enum for Redfish Device Enablement per
264    DSP0248_1.2.0
26511. state_set: Add CONNECTED and DISCONNECTED enum for Link State set
26612. entity: Add enum for Network Interface Connectors and Network Ports
267    Connection Types
26813. pdr: Add decode_numeric_effecter_pdr_data()
26914. oem: ibm: Support for the Real SAI entity id
27015. fw_update: Add encode req & decode resp for query_downstream_devices
27116. fw_update: Add encode req & decode resp for query_downstream_identifiers
27217. platform: Add support for GetStateEffecterStates command
273
274### Changed
275
2761. base: Stabilise pldm_msg_hdr_correlate_response()
2772. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind()
2783. libpldm: Fix header use
2794. libpldm: More fixes for header use
2805. pdr: Stabilise pldm_pdr_find_last_in_range() API
2816. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle()
2827. oem: meta: stabilise decode_oem_meta_file_io_req()
2838. pdr: pldm_entity_association_tree_copy_root(): Document preconditions
284
285### Deprecated
286
2871. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed
288   with `PLDM_OEM_IBM_`
289
290### Fixed
291
2921. libpldm: Rationalise the local and installed path of pldm.h
2932. pdr: Assign record_handle in entity_association_pdr_add_children()
2943. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value()
2954. pdr: Remove redundant constant for minimum numeric sensor PDR length
2965. tests: oem: meta: Fix fileio use of msgbuf
297
298## [0.7.0] - 2023-08-29
299
300### Added
301
3021. state-set: Add new enum for Operational Fault Status enum
303
304### Changed
305
3061. transport: Match specified metadata in pldm_transport_send_recv_msg()
3072. transport: mctp-demux: Drop ABI annotation for internal symbols
3083. transport: Stabilise core transport and implementation APIs
309
310   This stabilisation covers the following headers and functions:
311
312   - libpldm/transport.h
313
314     - pldm_transport_poll()
315     - pldm_transport_send_msg()
316     - pldm_transport_recv_msg()
317     - pldm_transport_send_recv_msg()
318
319   - libpldm/transport/af-mctp.h
320
321     - pldm_transport_af_mctp_init()
322     - pldm_transport_af_mctp_destroy()
323     - pldm_transport_af_mctp_core()
324     - pldm_transport_af_mctp_init_pollfd()
325     - pldm_transport_af_mctp_map_tid()
326     - pldm_transport_af_mctp_unmap_tid()
327
328   - libpldm/transport/mctp-demux.h
329     - pldm_transport_mctp_demux_init()
330     - pldm_transport_mctp_demux_destroy()
331     - pldm_transport_mctp_demux_core()
332     - pldm_transport_mctp_demux_init_pollfd()
333     - pldm_transport_mctp_demux_map_tid()
334     - pldm_transport_mctp_demux_unmap_tid()
335
336### Deprecated
337
3381. All the existing "requester" APIs from `libpldm/pldm.h` (also known as
339   `libpldm/requester/pldm.h`):
340
341   - pldm_open()
342   - pldm_send_recv()
343   - pldm_send()
344   - pldm_recv()
345   - pldm_recv_any()
346   - pldm_close()
347
348   Users should migrate to the newer "transport" APIs instead.
349
350## Fixed
351
3521. tests: Exclude transport tests when build excludes testing ABIs
3532. abi: Capture deprecation of pldm_close()
354
355## [0.6.0] - 2023-08-22
356
357### Changed
358
3591. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity()
3602. meson: Apply `b_ndebug=if-release` by default
3613. pdr : Stabilize pldm_entity_association_tree_add_entity()
3624. pdr: Stabilise pldm_entity_association_tree_find_with_locality()
3635. pdr: Stabilize pldm_entity_node_get_remote_container_id()
3646. transport: af-mctp: Assign out-params on success in \*\_recv()
3657. transport: Generalise the pldm_transport_recv_msg() API
366
367### Removed
368
3691. pdr: Remove pldm_entity_association_pdr_add()
3702. state-set: Remove enum pldm_state_set_operational_fault_status_values
371
372### Fixed
373
3741. transport: register init_pollfd callback for af-mctp
3752. transport: fix init_pollfd function parameter
3763. transport: Fix doxygen and variables for send and recv functions
3774. transport: af-mctp: Ensure malloc() succeeds in \*\_recv()
378
379## [0.5.0] - 2023-08-09
380
381### Added
382
3831. pdr: Introduce pldm_entity_association_pdr_add_check()
384
385### Changed
386
3871. pdr: Allow record_handle to be NULL for pldm_pdr_add_check()
3882. transport: pldm_transport_poll(): Adjust return value semantics
3893. transport: free un-wanted responses in pldm_transport_send_recv_msg()
390
391### Deprecated
392
3931. state-set: Enum pldm_state_set_operational_fault_status_values
394
395   The enum operational_fault_status is defined with wrong members and will
396   eventually be replaced with the correct members. Any uses of
397   pldm_state_set_operational_fault_status_values members should move to
398   equivalent pldm_state_set_operational_stress_status_values members if needed.
399
4002. platform: Struct field name in fru_record_set PDR
401
402   References to entity_instance_num should be changed to entity_instance
403
4043. platform: Struct field name in numeric sensor value PDR
405
406   References to entity_instance_num should be changed to entity_instance
407
408### Removed
409
4101. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length()
4112. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum()
4123. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string()
4134. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer()
4145. bios_table: Remove pldm_bios_table_append_pad_checksum()
4156. fru: Remove get_fru_record_by_option()
4167. pdr: Make is_present() static
4178. pdr: Remove pldm_pdr_add()
4189. pdr: Remove pldm_pdr_add_fru_record_set()
41910. pdr: Remove pldm_entity_association_pdr_add_from_node()
42011. pdr: Make find_entity_ref_in_tree() static
42112. pdr: Make entity_association_tree_find() static
422
423### Fixed
424
4251. requester: Fix response buffer cast in pldm_send_recv()
4262. pdr: Hoist record handle overflow test to avoid memory leak
4273. transport: Correct comparison in while loop condition
428
429## [0.4.0] - 2023-07-14
430
431### Added
432
4331. bios_table: Introduce pldm_bios_table_append_pad_checksum_check()
4342. fru: Introduce get_fru_record_by_option_check()
4353. pdr: Introduce pldm_entity_association_pdr_add_from_node_check()
4364. pdr: Introduce pldm_pdr_add_check()
4375. pdr: Introduce pldm_pdr_add_fru_record_set_check()
438
439### Changed
440
4411. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING
4422. requester: Expose pldm_close() in header
4433. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow
4444. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc
4455. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration
4466. pdr: pldm_pdr_init(): Return NULL on allocation failure
4477. pdr: pldm_pdr_destroy(): Exit early if repo is NULL
4488. pdr: Document preconditions for trivial accessor functions
449
450   A trivial accessor function is one that exposes properties of an object in a
451   way can't result in an error, beyond passing an invalid argument to the
452   function. For APIs meeting this definition we define a precondition that
453   struct pointers must point to valid objects to avoid polluting the function
454   prototypes. The following APIs now have this precondition explicitly defined:
455
456   - pldm_entity_extract()
457   - pldm_entity_get_parent()
458   - pldm_entity_is_exist_parent()
459   - pldm_entity_is_node_parent()
460   - pldm_is_current_parent_child
461   - pldm_is_empty_entity_assoc_tree()
462   - pldm_pdr_get_record_count()
463   - pldm_pdr_get_record_handle()
464   - pldm_pdr_get_repo_size()
465   - pldm_pdr_record_is_remote()
466
4679. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor
46810. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments
46911. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc
47012. pdr: pldm_entity_association_tree_visit(): Document preconditions
47113. pdr: pldm_entity_association_tree_visit(): Exit early on failure
47214. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument
47315. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments
47416. pdr: pldm_is_current_parent_child(): Return false for invalid arguments
47517. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments
47618. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments
47719. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments
47820. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg
47921. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments
48022. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit
48123. pdr: pldm_entity_get_num_children(): Don't return invalid values
48224. libpldm: Lift or remove asserts where a subsequent check exists
483
484### Deprecated
485
4861. pldm_bios_table_attr_entry_integer_encode()
487
488   Migrate to pldm_bios_table_attr_entry_integer_encode_check()
489
4902. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum()
491
492   Migrate to pldm_bios_table_attr_value_entry_encode_enum_check()
493
4943. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string()
495
496   Migrate to pldm_bios_table_attr_value_entry_encode_string_check()
497
4984. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer()
499
500   Migrate to pldm_bios_table_attr_value_entry_encode_integer_check()
501
5025. pdr: Deprecate is_present()
503
504   There should be no users of this symbol. If you are a user, you should figure
505   out how to stop, or get in touch. This symbol will be marked static the
506   release after deprecation.
507
5086. pdr: Deprecate find_entity_ref_in_tree()
509
510   There should be no users of this symbol. If you are a user, you should figure
511   out how to stop, or get in touch. This symbol will be marked static the
512   release after deprecation.
513
5147. pdr: Deprecate entity_association_tree_find()
515
516   There should be no users of this symbol. If you are a user, you should figure
517   out how to stop, or get in touch. This symbol will be marked static the
518   release after deprecation.
519
5208. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check()
521
522   pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of
523   pldm_bios_table_append_pad_checksum() should migrate to
524   pldm_bios_table_append_pad_checksum_check()
525
5269. fru: Stabilise get_fru_record_by_option_check()
527
528   get_fru_record_by_option() is deprecated by this change. Users of
529   get_fru_record_by_option() should migrate to get_fru_record_by_option_check()
530
53110. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check()
532
533    pldm_entity_association_pdr_add_from_node() is deprecated by this change.
534    Users of pldm_entity_association_pdr_add_from_node() should migrate to
535    pldm_entity_association_pdr_add_from_node_check()
536
53711. pdr: Stabilise pldm_pdr_add_check()
538
539    pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should
540    migrate to pldm_pdr_add_check()
541
54212. pdr: Stabilise pldm_pdr_add_fru_record_set_check()
543
544    pldm_pdr_add_fru_record_set() is deprecated by this change. Users of
545    pldm_pdr_add_fru_record_set() should migrate to
546    pldm_pdr_add_fru_record_set_check()
547
548### Removed
549
5501. bios_table: Remove deprecated APIs sanitized by assert():
551
552   - pldm_bios_table_string_entry_encode()
553   - pldm_bios_table_string_entry_decode_string()
554   - pldm_bios_table_attr_entry_enum_encode()
555   - pldm_bios_table_attr_entry_enum_decode_pv_num()
556   - pldm_bios_table_attr_entry_enum_decode_def_num()
557   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
558   - pldm_bios_table_attr_entry_string_encode()
559   - pldm_bios_table_attr_entry_string_decode_def_string_length()
560
561### Fixed
562
5631. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API
5642. pdr: Rework pldm_pdr_find_container_id_range_exclude() API
5653. transport: mctp-demux: Don't test socket for non-zero value
5664. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error
5675. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return
5686. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init()
5697. abi: Update to remove pldm_close() from reference dumps
5708. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer()
571
572## [0.3.0] - 2023-06-23
573
574### Added
575
5761. Add encode/decode pldmMessagePollEvent data
5772. README: Add a section on working with libpldm
5783. pdr: Introduce remote_container_id and associated APIs
5794. pdr: Add APIs for creating and locating remote PDRs
5805. pdr: Add pldm_pdr_find_last_in_range()
5816. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
5827. pdr: Add pldm_pdr_find_container_id_range_exclude()
583
584### Changed
585
5861. include: Move installed transport.h under libpldm/
5872. libpldm: Explicit deprecated, stable and testing ABI classes
5883. meson: Reduce strength of oem-ibm requirements from enabled to allowed
589
590   The `oem-ibm` feature is now enabled by the default meson configuration, for
591   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
592   recipe:
593
594   <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10>
595
596   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
597   when invoking `meson setup`
598
5994. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
6005. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
601
602### Deprecated
603
6041. bios_table: Deprecate APIs with arguments sanitized using assert()
605
606   C provides enough foot-guns without us encoding them into library APIs.
607   Specifically, deprecate the following in favour of their `*_check()` variants
608   which ensure assertions won't fail or otherwise invoke UB:
609
610   - pldm_bios_table_string_entry_encode()
611   - pldm_bios_table_string_entry_decode_string()
612   - pldm_bios_table_attr_entry_enum_encode()
613   - pldm_bios_table_attr_entry_enum_decode_pv_num()
614   - pldm_bios_table_attr_entry_enum_decode_def_num()
615   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
616   - pldm_bios_table_attr_entry_string_encode()
617   - pldm_bios_table_attr_entry_string_decode_def_string_length()
618
619### Removed
620
6211. libpldm: Remove the requester-api option
622
623### Fixed
624
6251. requester: Make pldm_open() return existing fd
6262. transport: Prevent sticking in waiting for response
6273. transport: Match on response in pldm_transport_send_recv_msg()
6284. requester: Add check before accessing hdr in pldm_recv()
6295. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
630