xref: /openbmc/libpldm/CHANGELOG.md (revision 8c43abb7)
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. ABI break for pldm_pdr_find_record()
42
43   Register assignment for function parameters was changed with the removal of
44   some asserts in related implementations.
45
463. ABI break for pldm_pdr_get_next_record()
47
48   Register assignment for function parameters was changed with the removal of
49   some asserts in related implementations.
50
514. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req()
52
53### Deprecated
54
551. oem: meta: Deprecate `decode_oem_meta_file_io_req()`
56
57   Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this
58   function to make it safer.
59
60   Modification:
61
62   - The meaning of the returned result.
63   - Change parameters from individual pointers to a struct.
64   - Check the length provided in the message won't exceed the buffer.
65
662. pldm_entity_association_tree_copy_root()
67
68   The implementation allocates, but gives no indication to the caller if an
69   allocation (and hence the copy) has failed. Users should migrate to
70   pldm_entity_association_tree_copy_root_check().
71
72### Removed
73
741. Deprecated functions with the `_check` suffix
75
76   - `get_fru_record_by_option_check()`
77   - `pldm_bios_table_append_pad_checksum_check()`
78   - `pldm_bios_table_attr_entry_enum_decode_def_num_check()`
79   - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()`
80   - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()`
81   - `pldm_bios_table_attr_entry_enum_encode_check()`
82   - `pldm_bios_table_attr_entry_integer_encode_check()`
83   - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()`
84   - `pldm_bios_table_attr_entry_string_encode_check()`
85   - `pldm_bios_table_attr_value_entry_encode_enum_check()`
86   - `pldm_bios_table_attr_value_entry_encode_integer_check()`
87   - `pldm_bios_table_attr_value_entry_encode_string_check()`
88   - `pldm_bios_table_string_entry_decode_string_check()`
89   - `pldm_bios_table_string_entry_encode_check()`
90   - `pldm_entity_association_pdr_add_check()`
91   - `pldm_entity_association_pdr_add_from_node_check()`
92   - `pldm_pdr_add_check()`
93   - `pldm_pdr_add_fru_record_set_check()`
94
95### Fixed
96
971. dsp: bios_table: Null check for pldm_bios_table_iter_is_end()
98
99   Avoid a caller-controlled NULL pointer dereference in the library
100   implementation.
101
1022. platform: fix encode/decode_poll_for_platform_event_message_req
103
104   Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to
105   follow spec.
106
1073. platform: Fix checking `eventIDToAcknowledge`
108
109   As the event receiver sends `PollForPlatformEventMessage` with the
110   `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge`
111   should be the previously retrieved eventID (from the PLDM terminus).
112
1134. dsp: platform: Fix decode_set_event_receiver_req()
114
115   The heartbeat field shall be omitted if `eventMessageGlobalEnable` is not
116   `enableAsyncKeepAlive`.
117
118## [0.9.1] - 2024-09-07
119
120### Changed
121
1221. Moved evolutions intended for v0.9.0 into place
123
124   Evolutions for the release have been moved from `evolutions/current` to
125   `evolutions/v0.9.1`. Library users can apply them to migrate off of
126   deprecated APIs.
127
128## [0.9.0] - 2024-09-07
129
130### Added
131
1321. base: Define macros for reserved TIDs
1332. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr()
1343. pdr: Add pldm_entity_association_pdr_create_new()
1354. platform: Define macros for the responded transferflags
1365. pdr: Add pldm_pdr_get_terminus_handle() API
1376. pdr: Add related decode_entity_auxiliary_names_pdr() APIs
1387. fw_update: Add encode req & decode resp for get_downstream_fw_params
1398. platform: Add decode_pldm_platform_cper_event() API
1409. decode_get_pdr_repository_info_resp_safe()
141
142   Replaces decode_get_pdr_repository_info_resp() as discussed in the
143   `Deprecated` section below
144
14510. decode_get_pdr_resp_safe()
146
147    Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section
148    below
149
150### Changed
151
1521. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs
1532. platform: Rework decode/encode_pldm_message_poll_event_data() APIs
1543. platform: Stabilise decode_pldm_message_poll_event_data() APIs
1554. ABI break for decode_sensor_op_data()
156
157   Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused
158   abi-compliance-checker to flag a change in the register containing the
159   parameter `previous_op_state`.
160
1615. platform: Stabilise decode_pldm_platform_cper_event() API
1626. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API
1637. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API
1648. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API
165
166### Deprecated
167
1681. Rename and deprecate functions with the `_check` suffix
169
170   All library function return values always need to be checked. The `_check`
171   suffix is redundant, so remove it. Migration to the non-deprecated
172   equivalents without the `_check` suffix can be performed using
173   `scripts/ apply-renames` and the [clang-rename][] configurations under
174   `evolutions/`
175
176   The deprecated functions:
177
178   - `get_fru_record_by_option_check()`
179   - `pldm_bios_table_append_pad_checksum_check()`
180   - `pldm_bios_table_attr_entry_enum_decode_def_num_check()`
181   - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()`
182   - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()`
183   - `pldm_bios_table_attr_entry_enum_encode_check()`
184   - `pldm_bios_table_attr_entry_integer_encode_check()`
185   - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()`
186   - `pldm_bios_table_attr_entry_string_encode_check()`
187   - `pldm_bios_table_attr_value_entry_encode_enum_check()`
188   - `pldm_bios_table_attr_value_entry_encode_integer_check()`
189   - `pldm_bios_table_attr_value_entry_encode_string_check()`
190   - `pldm_bios_table_string_entry_decode_string_check()`
191   - `pldm_bios_table_string_entry_encode_check()`
192   - `pldm_entity_association_pdr_add_check()`
193   - `pldm_entity_association_pdr_add_from_node_check()`
194   - `pldm_pdr_add_check()`
195   - `pldm_pdr_add_fru_record_set_check()`
196
197[clang-rename]: https://clang.llvm.org/extra/clang-rename.html
198
1992. `decode_get_pdr_repository_info_resp()`
200
201   Users should move to `decode_get_pdr_repository_info_resp_safe()` which
202   eliminates the opportunity for buffer overruns when extracting objects from
203   the message.
204
2053. `decode_get_pdr_resp()`
206
207   Users should move to `decode_get_pdr_resp_safe()` which reduces the
208   invocation tedium and improves memory safety over `decode_get_pdr_resp()`.
209
210### Removed
211
2121. IBM OEM header compatibility symlinks.
213
214   Anyone left using the deprecated paths can migrate using the coccinelle patch
215   at `evolutions/current/oem-ibm-header-compat.cocci`.
216
217### Fixed
218
2191. requester: instance-id: Release read lock on conflict
2202. pdr: Error propagation for
221   pldm_entity_association_pdr_add_from_node_with_record_handle()
222
223## [0.8.0] - 2024-05-23
224
225### Added
226
2271. base: Provide pldm_msg_hdr_correlate_response()
2282. transport: af-mctp: Add pldm_transport_af_mctp_bind()
2293. oem: ibm: Add chapdata file type support
2304. base: Added PLDM_SMBIOS & PLDM_RDE message types
2315. oem: meta: Add decode_oem_meta_file_io_req()
2326. state-set: Add all state set values to system power state enum as per DSP0249
2337. platform: Add alias members to the enum
234   pldm_pdr_repository_chg_event_change_record_event_data_operation.
235
236   enum constants with inconsistent names are deprecated with this change.
237   remove old inconsistent enum members after backward compatibility cleanup is
238   done
239
2408. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*`
2419. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type
24210. platform: Add 3 PDR type enum for Redfish Device Enablement per
243    DSP0248_1.2.0
24411. state_set: Add CONNECTED and DISCONNECTED enum for Link State set
24512. entity: Add enum for Network Interface Connectors and Network Ports
246    Connection Types
24713. pdr: Add decode_numeric_effecter_pdr_data()
24814. oem: ibm: Support for the Real SAI entity id
24915. fw_update: Add encode req & decode resp for query_downstream_devices
25016. fw_update: Add encode req & decode resp for query_downstream_identifiers
25117. platform: Add support for GetStateEffecterStates command
252
253### Changed
254
2551. base: Stabilise pldm_msg_hdr_correlate_response()
2562. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind()
2573. libpldm: Fix header use
2584. libpldm: More fixes for header use
2595. pdr: Stabilise pldm_pdr_find_last_in_range() API
2606. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle()
2617. oem: meta: stabilise decode_oem_meta_file_io_req()
2628. pdr: pldm_entity_association_tree_copy_root(): Document preconditions
263
264### Deprecated
265
2661. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed
267   with `PLDM_OEM_IBM_`
268
269### Fixed
270
2711. libpldm: Rationalise the local and installed path of pldm.h
2722. pdr: Assign record_handle in entity_association_pdr_add_children()
2733. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value()
2744. pdr: Remove redundant constant for minimum numeric sensor PDR length
2755. tests: oem: meta: Fix fileio use of msgbuf
276
277## [0.7.0] - 2023-08-29
278
279### Added
280
2811. state-set: Add new enum for Operational Fault Status enum
282
283### Changed
284
2851. transport: Match specified metadata in pldm_transport_send_recv_msg()
2862. transport: mctp-demux: Drop ABI annotation for internal symbols
2873. transport: Stabilise core transport and implementation APIs
288
289   This stabilisation covers the following headers and functions:
290
291   - libpldm/transport.h
292
293     - pldm_transport_poll()
294     - pldm_transport_send_msg()
295     - pldm_transport_recv_msg()
296     - pldm_transport_send_recv_msg()
297
298   - libpldm/transport/af-mctp.h
299
300     - pldm_transport_af_mctp_init()
301     - pldm_transport_af_mctp_destroy()
302     - pldm_transport_af_mctp_core()
303     - pldm_transport_af_mctp_init_pollfd()
304     - pldm_transport_af_mctp_map_tid()
305     - pldm_transport_af_mctp_unmap_tid()
306
307   - libpldm/transport/mctp-demux.h
308     - pldm_transport_mctp_demux_init()
309     - pldm_transport_mctp_demux_destroy()
310     - pldm_transport_mctp_demux_core()
311     - pldm_transport_mctp_demux_init_pollfd()
312     - pldm_transport_mctp_demux_map_tid()
313     - pldm_transport_mctp_demux_unmap_tid()
314
315### Deprecated
316
3171. All the existing "requester" APIs from `libpldm/pldm.h` (also known as
318   `libpldm/requester/pldm.h`):
319
320   - pldm_open()
321   - pldm_send_recv()
322   - pldm_send()
323   - pldm_recv()
324   - pldm_recv_any()
325   - pldm_close()
326
327   Users should migrate to the newer "transport" APIs instead.
328
329## Fixed
330
3311. tests: Exclude transport tests when build excludes testing ABIs
3322. abi: Capture deprecation of pldm_close()
333
334## [0.6.0] - 2023-08-22
335
336### Changed
337
3381. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity()
3392. meson: Apply `b_ndebug=if-release` by default
3403. pdr : Stabilize pldm_entity_association_tree_add_entity()
3414. pdr: Stabilise pldm_entity_association_tree_find_with_locality()
3425. pdr: Stabilize pldm_entity_node_get_remote_container_id()
3436. transport: af-mctp: Assign out-params on success in \*\_recv()
3447. transport: Generalise the pldm_transport_recv_msg() API
345
346### Removed
347
3481. pdr: Remove pldm_entity_association_pdr_add()
3492. state-set: Remove enum pldm_state_set_operational_fault_status_values
350
351### Fixed
352
3531. transport: register init_pollfd callback for af-mctp
3542. transport: fix init_pollfd function parameter
3553. transport: Fix doxygen and variables for send and recv functions
3564. transport: af-mctp: Ensure malloc() succeeds in \*\_recv()
357
358## [0.5.0] - 2023-08-09
359
360### Added
361
3621. pdr: Introduce pldm_entity_association_pdr_add_check()
363
364### Changed
365
3661. pdr: Allow record_handle to be NULL for pldm_pdr_add_check()
3672. transport: pldm_transport_poll(): Adjust return value semantics
3683. transport: free un-wanted responses in pldm_transport_send_recv_msg()
369
370### Deprecated
371
3721. state-set: Enum pldm_state_set_operational_fault_status_values
373
374   The enum operational_fault_status is defined with wrong members and will
375   eventually be replaced with the correct members. Any uses of
376   pldm_state_set_operational_fault_status_values members should move to
377   equivalent pldm_state_set_operational_stress_status_values members if needed.
378
3792. platform: Struct field name in fru_record_set PDR
380
381   References to entity_instance_num should be changed to entity_instance
382
3833. platform: Struct field name in numeric sensor value PDR
384
385   References to entity_instance_num should be changed to entity_instance
386
387### Removed
388
3891. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length()
3902. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum()
3913. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string()
3924. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer()
3935. bios_table: Remove pldm_bios_table_append_pad_checksum()
3946. fru: Remove get_fru_record_by_option()
3957. pdr: Make is_present() static
3968. pdr: Remove pldm_pdr_add()
3979. pdr: Remove pldm_pdr_add_fru_record_set()
39810. pdr: Remove pldm_entity_association_pdr_add_from_node()
39911. pdr: Make find_entity_ref_in_tree() static
40012. pdr: Make entity_association_tree_find() static
401
402### Fixed
403
4041. requester: Fix response buffer cast in pldm_send_recv()
4052. pdr: Hoist record handle overflow test to avoid memory leak
4063. transport: Correct comparison in while loop condition
407
408## [0.4.0] - 2023-07-14
409
410### Added
411
4121. bios_table: Introduce pldm_bios_table_append_pad_checksum_check()
4132. fru: Introduce get_fru_record_by_option_check()
4143. pdr: Introduce pldm_entity_association_pdr_add_from_node_check()
4154. pdr: Introduce pldm_pdr_add_check()
4165. pdr: Introduce pldm_pdr_add_fru_record_set_check()
417
418### Changed
419
4201. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING
4212. requester: Expose pldm_close() in header
4223. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow
4234. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc
4245. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration
4256. pdr: pldm_pdr_init(): Return NULL on allocation failure
4267. pdr: pldm_pdr_destroy(): Exit early if repo is NULL
4278. pdr: Document preconditions for trivial accessor functions
428
429   A trivial accessor function is one that exposes properties of an object in a
430   way can't result in an error, beyond passing an invalid argument to the
431   function. For APIs meeting this definition we define a precondition that
432   struct pointers must point to valid objects to avoid polluting the function
433   prototypes. The following APIs now have this precondition explicitly defined:
434
435   - pldm_entity_extract()
436   - pldm_entity_get_parent()
437   - pldm_entity_is_exist_parent()
438   - pldm_entity_is_node_parent()
439   - pldm_is_current_parent_child
440   - pldm_is_empty_entity_assoc_tree()
441   - pldm_pdr_get_record_count()
442   - pldm_pdr_get_record_handle()
443   - pldm_pdr_get_repo_size()
444   - pldm_pdr_record_is_remote()
445
4469. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor
44710. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments
44811. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc
44912. pdr: pldm_entity_association_tree_visit(): Document preconditions
45013. pdr: pldm_entity_association_tree_visit(): Exit early on failure
45114. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument
45215. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments
45316. pdr: pldm_is_current_parent_child(): Return false for invalid arguments
45417. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments
45518. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments
45619. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments
45720. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg
45821. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments
45922. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit
46023. pdr: pldm_entity_get_num_children(): Don't return invalid values
46124. libpldm: Lift or remove asserts where a subsequent check exists
462
463### Deprecated
464
4651. pldm_bios_table_attr_entry_integer_encode()
466
467   Migrate to pldm_bios_table_attr_entry_integer_encode_check()
468
4692. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum()
470
471   Migrate to pldm_bios_table_attr_value_entry_encode_enum_check()
472
4733. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string()
474
475   Migrate to pldm_bios_table_attr_value_entry_encode_string_check()
476
4774. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer()
478
479   Migrate to pldm_bios_table_attr_value_entry_encode_integer_check()
480
4815. pdr: Deprecate is_present()
482
483   There should be no users of this symbol. If you are a user, you should figure
484   out how to stop, or get in touch. This symbol will be marked static the
485   release after deprecation.
486
4876. pdr: Deprecate find_entity_ref_in_tree()
488
489   There should be no users of this symbol. If you are a user, you should figure
490   out how to stop, or get in touch. This symbol will be marked static the
491   release after deprecation.
492
4937. pdr: Deprecate entity_association_tree_find()
494
495   There should be no users of this symbol. If you are a user, you should figure
496   out how to stop, or get in touch. This symbol will be marked static the
497   release after deprecation.
498
4998. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check()
500
501   pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of
502   pldm_bios_table_append_pad_checksum() should migrate to
503   pldm_bios_table_append_pad_checksum_check()
504
5059. fru: Stabilise get_fru_record_by_option_check()
506
507   get_fru_record_by_option() is deprecated by this change. Users of
508   get_fru_record_by_option() should migrate to get_fru_record_by_option_check()
509
51010. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check()
511
512    pldm_entity_association_pdr_add_from_node() is deprecated by this change.
513    Users of pldm_entity_association_pdr_add_from_node() should migrate to
514    pldm_entity_association_pdr_add_from_node_check()
515
51611. pdr: Stabilise pldm_pdr_add_check()
517
518    pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should
519    migrate to pldm_pdr_add_check()
520
52112. pdr: Stabilise pldm_pdr_add_fru_record_set_check()
522
523    pldm_pdr_add_fru_record_set() is deprecated by this change. Users of
524    pldm_pdr_add_fru_record_set() should migrate to
525    pldm_pdr_add_fru_record_set_check()
526
527### Removed
528
5291. bios_table: Remove deprecated APIs sanitized by assert():
530
531   - pldm_bios_table_string_entry_encode()
532   - pldm_bios_table_string_entry_decode_string()
533   - pldm_bios_table_attr_entry_enum_encode()
534   - pldm_bios_table_attr_entry_enum_decode_pv_num()
535   - pldm_bios_table_attr_entry_enum_decode_def_num()
536   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
537   - pldm_bios_table_attr_entry_string_encode()
538   - pldm_bios_table_attr_entry_string_decode_def_string_length()
539
540### Fixed
541
5421. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API
5432. pdr: Rework pldm_pdr_find_container_id_range_exclude() API
5443. transport: mctp-demux: Don't test socket for non-zero value
5454. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error
5465. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return
5476. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init()
5487. abi: Update to remove pldm_close() from reference dumps
5498. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer()
550
551## [0.3.0] - 2023-06-23
552
553### Added
554
5551. Add encode/decode pldmMessagePollEvent data
5562. README: Add a section on working with libpldm
5573. pdr: Introduce remote_container_id and associated APIs
5584. pdr: Add APIs for creating and locating remote PDRs
5595. pdr: Add pldm_pdr_find_last_in_range()
5606. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
5617. pdr: Add pldm_pdr_find_container_id_range_exclude()
562
563### Changed
564
5651. include: Move installed transport.h under libpldm/
5662. libpldm: Explicit deprecated, stable and testing ABI classes
5673. meson: Reduce strength of oem-ibm requirements from enabled to allowed
568
569   The `oem-ibm` feature is now enabled by the default meson configuration, for
570   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
571   recipe:
572
573   <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10>
574
575   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
576   when invoking `meson setup`
577
5784. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
5795. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
580
581### Deprecated
582
5831. bios_table: Deprecate APIs with arguments sanitized using assert()
584
585   C provides enough foot-guns without us encoding them into library APIs.
586   Specifically, deprecate the following in favour of their `*_check()` variants
587   which ensure assertions won't fail or otherwise invoke UB:
588
589   - pldm_bios_table_string_entry_encode()
590   - pldm_bios_table_string_entry_decode_string()
591   - pldm_bios_table_attr_entry_enum_encode()
592   - pldm_bios_table_attr_entry_enum_decode_pv_num()
593   - pldm_bios_table_attr_entry_enum_decode_def_num()
594   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
595   - pldm_bios_table_attr_entry_string_encode()
596   - pldm_bios_table_attr_entry_string_decode_def_string_length()
597
598### Removed
599
6001. libpldm: Remove the requester-api option
601
602### Fixed
603
6041. requester: Make pldm_open() return existing fd
6052. transport: Prevent sticking in waiting for response
6063. transport: Match on response in pldm_transport_send_recv_msg()
6074. requester: Add check before accessing hdr in pldm_recv()
6085. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
609