xref: /openbmc/libpldm/CHANGELOG.md (revision 57d9a2ef6d7f85efdb89ba084af620a318b741e2)
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()
137
138## [0.9.1] - 2024-09-07
139
140### Changed
141
1421. Moved evolutions intended for v0.9.0 into place
143
144   Evolutions for the release have been moved from `evolutions/current` to
145   `evolutions/v0.9.1`. Library users can apply them to migrate off of
146   deprecated APIs.
147
148## [0.9.0] - 2024-09-07
149
150### Added
151
1521. base: Define macros for reserved TIDs
1532. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr()
1543. pdr: Add pldm_entity_association_pdr_create_new()
1554. platform: Define macros for the responded transferflags
1565. pdr: Add pldm_pdr_get_terminus_handle() API
1576. pdr: Add related decode_entity_auxiliary_names_pdr() APIs
1587. fw_update: Add encode req & decode resp for get_downstream_fw_params
1598. platform: Add decode_pldm_platform_cper_event() API
1609. decode_get_pdr_repository_info_resp_safe()
161
162   Replaces decode_get_pdr_repository_info_resp() as discussed in the
163   `Deprecated` section below
164
16510. decode_get_pdr_resp_safe()
166
167    Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section
168    below
169
170### Changed
171
1721. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs
1732. platform: Rework decode/encode_pldm_message_poll_event_data() APIs
1743. platform: Stabilise decode_pldm_message_poll_event_data() APIs
1754. ABI break for decode_sensor_op_data()
176
177   Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused
178   abi-compliance-checker to flag a change in the register containing the
179   parameter `previous_op_state`.
180
1815. platform: Stabilise decode_pldm_platform_cper_event() API
1826. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API
1837. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API
1848. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API
185
186### Deprecated
187
1881. Rename and deprecate functions with the `_check` suffix
189
190   All library function return values always need to be checked. The `_check`
191   suffix is redundant, so remove it. Migration to the non-deprecated
192   equivalents without the `_check` suffix can be performed using
193   `scripts/ apply-renames` and the [clang-rename][] configurations under
194   `evolutions/`
195
196   The deprecated functions:
197
198   - `get_fru_record_by_option_check()`
199   - `pldm_bios_table_append_pad_checksum_check()`
200   - `pldm_bios_table_attr_entry_enum_decode_def_num_check()`
201   - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()`
202   - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()`
203   - `pldm_bios_table_attr_entry_enum_encode_check()`
204   - `pldm_bios_table_attr_entry_integer_encode_check()`
205   - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()`
206   - `pldm_bios_table_attr_entry_string_encode_check()`
207   - `pldm_bios_table_attr_value_entry_encode_enum_check()`
208   - `pldm_bios_table_attr_value_entry_encode_integer_check()`
209   - `pldm_bios_table_attr_value_entry_encode_string_check()`
210   - `pldm_bios_table_string_entry_decode_string_check()`
211   - `pldm_bios_table_string_entry_encode_check()`
212   - `pldm_entity_association_pdr_add_check()`
213   - `pldm_entity_association_pdr_add_from_node_check()`
214   - `pldm_pdr_add_check()`
215   - `pldm_pdr_add_fru_record_set_check()`
216
217[clang-rename]: https://clang.llvm.org/extra/clang-rename.html
218
2192. `decode_get_pdr_repository_info_resp()`
220
221   Users should move to `decode_get_pdr_repository_info_resp_safe()` which
222   eliminates the opportunity for buffer overruns when extracting objects from
223   the message.
224
2253. `decode_get_pdr_resp()`
226
227   Users should move to `decode_get_pdr_resp_safe()` which reduces the
228   invocation tedium and improves memory safety over `decode_get_pdr_resp()`.
229
230### Removed
231
2321. IBM OEM header compatibility symlinks.
233
234   Anyone left using the deprecated paths can migrate using the coccinelle patch
235   at `evolutions/current/oem-ibm-header-compat.cocci`.
236
237### Fixed
238
2391. requester: instance-id: Release read lock on conflict
2402. pdr: Error propagation for
241   pldm_entity_association_pdr_add_from_node_with_record_handle()
242
243## [0.8.0] - 2024-05-23
244
245### Added
246
2471. base: Provide pldm_msg_hdr_correlate_response()
2482. transport: af-mctp: Add pldm_transport_af_mctp_bind()
2493. oem: ibm: Add chapdata file type support
2504. base: Added PLDM_SMBIOS & PLDM_RDE message types
2515. oem: meta: Add decode_oem_meta_file_io_req()
2526. state-set: Add all state set values to system power state enum as per DSP0249
2537. platform: Add alias members to the enum
254   pldm_pdr_repository_chg_event_change_record_event_data_operation.
255
256   enum constants with inconsistent names are deprecated with this change.
257   remove old inconsistent enum members after backward compatibility cleanup is
258   done
259
2608. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*`
2619. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type
26210. platform: Add 3 PDR type enum for Redfish Device Enablement per
263    DSP0248_1.2.0
26411. state_set: Add CONNECTED and DISCONNECTED enum for Link State set
26512. entity: Add enum for Network Interface Connectors and Network Ports
266    Connection Types
26713. pdr: Add decode_numeric_effecter_pdr_data()
26814. oem: ibm: Support for the Real SAI entity id
26915. fw_update: Add encode req & decode resp for query_downstream_devices
27016. fw_update: Add encode req & decode resp for query_downstream_identifiers
27117. platform: Add support for GetStateEffecterStates command
272
273### Changed
274
2751. base: Stabilise pldm_msg_hdr_correlate_response()
2762. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind()
2773. libpldm: Fix header use
2784. libpldm: More fixes for header use
2795. pdr: Stabilise pldm_pdr_find_last_in_range() API
2806. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle()
2817. oem: meta: stabilise decode_oem_meta_file_io_req()
2828. pdr: pldm_entity_association_tree_copy_root(): Document preconditions
283
284### Deprecated
285
2861. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed
287   with `PLDM_OEM_IBM_`
288
289### Fixed
290
2911. libpldm: Rationalise the local and installed path of pldm.h
2922. pdr: Assign record_handle in entity_association_pdr_add_children()
2933. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value()
2944. pdr: Remove redundant constant for minimum numeric sensor PDR length
2955. tests: oem: meta: Fix fileio use of msgbuf
296
297## [0.7.0] - 2023-08-29
298
299### Added
300
3011. state-set: Add new enum for Operational Fault Status enum
302
303### Changed
304
3051. transport: Match specified metadata in pldm_transport_send_recv_msg()
3062. transport: mctp-demux: Drop ABI annotation for internal symbols
3073. transport: Stabilise core transport and implementation APIs
308
309   This stabilisation covers the following headers and functions:
310
311   - libpldm/transport.h
312
313     - pldm_transport_poll()
314     - pldm_transport_send_msg()
315     - pldm_transport_recv_msg()
316     - pldm_transport_send_recv_msg()
317
318   - libpldm/transport/af-mctp.h
319
320     - pldm_transport_af_mctp_init()
321     - pldm_transport_af_mctp_destroy()
322     - pldm_transport_af_mctp_core()
323     - pldm_transport_af_mctp_init_pollfd()
324     - pldm_transport_af_mctp_map_tid()
325     - pldm_transport_af_mctp_unmap_tid()
326
327   - libpldm/transport/mctp-demux.h
328     - pldm_transport_mctp_demux_init()
329     - pldm_transport_mctp_demux_destroy()
330     - pldm_transport_mctp_demux_core()
331     - pldm_transport_mctp_demux_init_pollfd()
332     - pldm_transport_mctp_demux_map_tid()
333     - pldm_transport_mctp_demux_unmap_tid()
334
335### Deprecated
336
3371. All the existing "requester" APIs from `libpldm/pldm.h` (also known as
338   `libpldm/requester/pldm.h`):
339
340   - pldm_open()
341   - pldm_send_recv()
342   - pldm_send()
343   - pldm_recv()
344   - pldm_recv_any()
345   - pldm_close()
346
347   Users should migrate to the newer "transport" APIs instead.
348
349## Fixed
350
3511. tests: Exclude transport tests when build excludes testing ABIs
3522. abi: Capture deprecation of pldm_close()
353
354## [0.6.0] - 2023-08-22
355
356### Changed
357
3581. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity()
3592. meson: Apply `b_ndebug=if-release` by default
3603. pdr : Stabilize pldm_entity_association_tree_add_entity()
3614. pdr: Stabilise pldm_entity_association_tree_find_with_locality()
3625. pdr: Stabilize pldm_entity_node_get_remote_container_id()
3636. transport: af-mctp: Assign out-params on success in \*\_recv()
3647. transport: Generalise the pldm_transport_recv_msg() API
365
366### Removed
367
3681. pdr: Remove pldm_entity_association_pdr_add()
3692. state-set: Remove enum pldm_state_set_operational_fault_status_values
370
371### Fixed
372
3731. transport: register init_pollfd callback for af-mctp
3742. transport: fix init_pollfd function parameter
3753. transport: Fix doxygen and variables for send and recv functions
3764. transport: af-mctp: Ensure malloc() succeeds in \*\_recv()
377
378## [0.5.0] - 2023-08-09
379
380### Added
381
3821. pdr: Introduce pldm_entity_association_pdr_add_check()
383
384### Changed
385
3861. pdr: Allow record_handle to be NULL for pldm_pdr_add_check()
3872. transport: pldm_transport_poll(): Adjust return value semantics
3883. transport: free un-wanted responses in pldm_transport_send_recv_msg()
389
390### Deprecated
391
3921. state-set: Enum pldm_state_set_operational_fault_status_values
393
394   The enum operational_fault_status is defined with wrong members and will
395   eventually be replaced with the correct members. Any uses of
396   pldm_state_set_operational_fault_status_values members should move to
397   equivalent pldm_state_set_operational_stress_status_values members if needed.
398
3992. platform: Struct field name in fru_record_set PDR
400
401   References to entity_instance_num should be changed to entity_instance
402
4033. platform: Struct field name in numeric sensor value PDR
404
405   References to entity_instance_num should be changed to entity_instance
406
407### Removed
408
4091. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length()
4102. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum()
4113. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string()
4124. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer()
4135. bios_table: Remove pldm_bios_table_append_pad_checksum()
4146. fru: Remove get_fru_record_by_option()
4157. pdr: Make is_present() static
4168. pdr: Remove pldm_pdr_add()
4179. pdr: Remove pldm_pdr_add_fru_record_set()
41810. pdr: Remove pldm_entity_association_pdr_add_from_node()
41911. pdr: Make find_entity_ref_in_tree() static
42012. pdr: Make entity_association_tree_find() static
421
422### Fixed
423
4241. requester: Fix response buffer cast in pldm_send_recv()
4252. pdr: Hoist record handle overflow test to avoid memory leak
4263. transport: Correct comparison in while loop condition
427
428## [0.4.0] - 2023-07-14
429
430### Added
431
4321. bios_table: Introduce pldm_bios_table_append_pad_checksum_check()
4332. fru: Introduce get_fru_record_by_option_check()
4343. pdr: Introduce pldm_entity_association_pdr_add_from_node_check()
4354. pdr: Introduce pldm_pdr_add_check()
4365. pdr: Introduce pldm_pdr_add_fru_record_set_check()
437
438### Changed
439
4401. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING
4412. requester: Expose pldm_close() in header
4423. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow
4434. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc
4445. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration
4456. pdr: pldm_pdr_init(): Return NULL on allocation failure
4467. pdr: pldm_pdr_destroy(): Exit early if repo is NULL
4478. pdr: Document preconditions for trivial accessor functions
448
449   A trivial accessor function is one that exposes properties of an object in a
450   way can't result in an error, beyond passing an invalid argument to the
451   function. For APIs meeting this definition we define a precondition that
452   struct pointers must point to valid objects to avoid polluting the function
453   prototypes. The following APIs now have this precondition explicitly defined:
454
455   - pldm_entity_extract()
456   - pldm_entity_get_parent()
457   - pldm_entity_is_exist_parent()
458   - pldm_entity_is_node_parent()
459   - pldm_is_current_parent_child
460   - pldm_is_empty_entity_assoc_tree()
461   - pldm_pdr_get_record_count()
462   - pldm_pdr_get_record_handle()
463   - pldm_pdr_get_repo_size()
464   - pldm_pdr_record_is_remote()
465
4669. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor
46710. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments
46811. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc
46912. pdr: pldm_entity_association_tree_visit(): Document preconditions
47013. pdr: pldm_entity_association_tree_visit(): Exit early on failure
47114. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument
47215. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments
47316. pdr: pldm_is_current_parent_child(): Return false for invalid arguments
47417. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments
47518. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments
47619. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments
47720. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg
47821. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments
47922. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit
48023. pdr: pldm_entity_get_num_children(): Don't return invalid values
48124. libpldm: Lift or remove asserts where a subsequent check exists
482
483### Deprecated
484
4851. pldm_bios_table_attr_entry_integer_encode()
486
487   Migrate to pldm_bios_table_attr_entry_integer_encode_check()
488
4892. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum()
490
491   Migrate to pldm_bios_table_attr_value_entry_encode_enum_check()
492
4933. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string()
494
495   Migrate to pldm_bios_table_attr_value_entry_encode_string_check()
496
4974. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer()
498
499   Migrate to pldm_bios_table_attr_value_entry_encode_integer_check()
500
5015. pdr: Deprecate is_present()
502
503   There should be no users of this symbol. If you are a user, you should figure
504   out how to stop, or get in touch. This symbol will be marked static the
505   release after deprecation.
506
5076. pdr: Deprecate find_entity_ref_in_tree()
508
509   There should be no users of this symbol. If you are a user, you should figure
510   out how to stop, or get in touch. This symbol will be marked static the
511   release after deprecation.
512
5137. pdr: Deprecate entity_association_tree_find()
514
515   There should be no users of this symbol. If you are a user, you should figure
516   out how to stop, or get in touch. This symbol will be marked static the
517   release after deprecation.
518
5198. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check()
520
521   pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of
522   pldm_bios_table_append_pad_checksum() should migrate to
523   pldm_bios_table_append_pad_checksum_check()
524
5259. fru: Stabilise get_fru_record_by_option_check()
526
527   get_fru_record_by_option() is deprecated by this change. Users of
528   get_fru_record_by_option() should migrate to get_fru_record_by_option_check()
529
53010. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check()
531
532    pldm_entity_association_pdr_add_from_node() is deprecated by this change.
533    Users of pldm_entity_association_pdr_add_from_node() should migrate to
534    pldm_entity_association_pdr_add_from_node_check()
535
53611. pdr: Stabilise pldm_pdr_add_check()
537
538    pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should
539    migrate to pldm_pdr_add_check()
540
54112. pdr: Stabilise pldm_pdr_add_fru_record_set_check()
542
543    pldm_pdr_add_fru_record_set() is deprecated by this change. Users of
544    pldm_pdr_add_fru_record_set() should migrate to
545    pldm_pdr_add_fru_record_set_check()
546
547### Removed
548
5491. bios_table: Remove deprecated APIs sanitized by assert():
550
551   - pldm_bios_table_string_entry_encode()
552   - pldm_bios_table_string_entry_decode_string()
553   - pldm_bios_table_attr_entry_enum_encode()
554   - pldm_bios_table_attr_entry_enum_decode_pv_num()
555   - pldm_bios_table_attr_entry_enum_decode_def_num()
556   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
557   - pldm_bios_table_attr_entry_string_encode()
558   - pldm_bios_table_attr_entry_string_decode_def_string_length()
559
560### Fixed
561
5621. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API
5632. pdr: Rework pldm_pdr_find_container_id_range_exclude() API
5643. transport: mctp-demux: Don't test socket for non-zero value
5654. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error
5665. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return
5676. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init()
5687. abi: Update to remove pldm_close() from reference dumps
5698. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer()
570
571## [0.3.0] - 2023-06-23
572
573### Added
574
5751. Add encode/decode pldmMessagePollEvent data
5762. README: Add a section on working with libpldm
5773. pdr: Introduce remote_container_id and associated APIs
5784. pdr: Add APIs for creating and locating remote PDRs
5795. pdr: Add pldm_pdr_find_last_in_range()
5806. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
5817. pdr: Add pldm_pdr_find_container_id_range_exclude()
582
583### Changed
584
5851. include: Move installed transport.h under libpldm/
5862. libpldm: Explicit deprecated, stable and testing ABI classes
5873. meson: Reduce strength of oem-ibm requirements from enabled to allowed
588
589   The `oem-ibm` feature is now enabled by the default meson configuration, for
590   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
591   recipe:
592
593   <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10>
594
595   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
596   when invoking `meson setup`
597
5984. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
5995. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
600
601### Deprecated
602
6031. bios_table: Deprecate APIs with arguments sanitized using assert()
604
605   C provides enough foot-guns without us encoding them into library APIs.
606   Specifically, deprecate the following in favour of their `*_check()` variants
607   which ensure assertions won't fail or otherwise invoke UB:
608
609   - pldm_bios_table_string_entry_encode()
610   - pldm_bios_table_string_entry_decode_string()
611   - pldm_bios_table_attr_entry_enum_encode()
612   - pldm_bios_table_attr_entry_enum_decode_pv_num()
613   - pldm_bios_table_attr_entry_enum_decode_def_num()
614   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
615   - pldm_bios_table_attr_entry_string_encode()
616   - pldm_bios_table_attr_entry_string_decode_def_string_length()
617
618### Removed
619
6201. libpldm: Remove the requester-api option
621
622### Fixed
623
6241. requester: Make pldm_open() return existing fd
6252. transport: Prevent sticking in waiting for response
6263. transport: Match on response in pldm_transport_send_recv_msg()
6274. requester: Add check before accessing hdr in pldm_recv()
6285. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
629