xref: /openbmc/libpldm/CHANGELOG.md (revision 37016fef)
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()
13814. dsp: fru: Bounds check encode_fru_record()
13915. dsp: bios: Bounds check encode_set_bios_table_req()
140
141## [0.9.1] - 2024-09-07
142
143### Changed
144
1451. Moved evolutions intended for v0.9.0 into place
146
147   Evolutions for the release have been moved from `evolutions/current` to
148   `evolutions/v0.9.1`. Library users can apply them to migrate off of
149   deprecated APIs.
150
151## [0.9.0] - 2024-09-07
152
153### Added
154
1551. base: Define macros for reserved TIDs
1562. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr()
1573. pdr: Add pldm_entity_association_pdr_create_new()
1584. platform: Define macros for the responded transferflags
1595. pdr: Add pldm_pdr_get_terminus_handle() API
1606. pdr: Add related decode_entity_auxiliary_names_pdr() APIs
1617. fw_update: Add encode req & decode resp for get_downstream_fw_params
1628. platform: Add decode_pldm_platform_cper_event() API
1639. decode_get_pdr_repository_info_resp_safe()
164
165   Replaces decode_get_pdr_repository_info_resp() as discussed in the
166   `Deprecated` section below
167
16810. decode_get_pdr_resp_safe()
169
170    Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section
171    below
172
173### Changed
174
1751. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs
1762. platform: Rework decode/encode_pldm_message_poll_event_data() APIs
1773. platform: Stabilise decode_pldm_message_poll_event_data() APIs
1784. ABI break for decode_sensor_op_data()
179
180   Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused
181   abi-compliance-checker to flag a change in the register containing the
182   parameter `previous_op_state`.
183
1845. platform: Stabilise decode_pldm_platform_cper_event() API
1856. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API
1867. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API
1878. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API
188
189### Deprecated
190
1911. Rename and deprecate functions with the `_check` suffix
192
193   All library function return values always need to be checked. The `_check`
194   suffix is redundant, so remove it. Migration to the non-deprecated
195   equivalents without the `_check` suffix can be performed using
196   `scripts/ apply-renames` and the [clang-rename][] configurations under
197   `evolutions/`
198
199   The deprecated functions:
200
201   - `get_fru_record_by_option_check()`
202   - `pldm_bios_table_append_pad_checksum_check()`
203   - `pldm_bios_table_attr_entry_enum_decode_def_num_check()`
204   - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()`
205   - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()`
206   - `pldm_bios_table_attr_entry_enum_encode_check()`
207   - `pldm_bios_table_attr_entry_integer_encode_check()`
208   - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()`
209   - `pldm_bios_table_attr_entry_string_encode_check()`
210   - `pldm_bios_table_attr_value_entry_encode_enum_check()`
211   - `pldm_bios_table_attr_value_entry_encode_integer_check()`
212   - `pldm_bios_table_attr_value_entry_encode_string_check()`
213   - `pldm_bios_table_string_entry_decode_string_check()`
214   - `pldm_bios_table_string_entry_encode_check()`
215   - `pldm_entity_association_pdr_add_check()`
216   - `pldm_entity_association_pdr_add_from_node_check()`
217   - `pldm_pdr_add_check()`
218   - `pldm_pdr_add_fru_record_set_check()`
219
220[clang-rename]: https://clang.llvm.org/extra/clang-rename.html
221
2222. `decode_get_pdr_repository_info_resp()`
223
224   Users should move to `decode_get_pdr_repository_info_resp_safe()` which
225   eliminates the opportunity for buffer overruns when extracting objects from
226   the message.
227
2283. `decode_get_pdr_resp()`
229
230   Users should move to `decode_get_pdr_resp_safe()` which reduces the
231   invocation tedium and improves memory safety over `decode_get_pdr_resp()`.
232
233### Removed
234
2351. IBM OEM header compatibility symlinks.
236
237   Anyone left using the deprecated paths can migrate using the coccinelle patch
238   at `evolutions/current/oem-ibm-header-compat.cocci`.
239
240### Fixed
241
2421. requester: instance-id: Release read lock on conflict
2432. pdr: Error propagation for
244   pldm_entity_association_pdr_add_from_node_with_record_handle()
245
246## [0.8.0] - 2024-05-23
247
248### Added
249
2501. base: Provide pldm_msg_hdr_correlate_response()
2512. transport: af-mctp: Add pldm_transport_af_mctp_bind()
2523. oem: ibm: Add chapdata file type support
2534. base: Added PLDM_SMBIOS & PLDM_RDE message types
2545. oem: meta: Add decode_oem_meta_file_io_req()
2556. state-set: Add all state set values to system power state enum as per DSP0249
2567. platform: Add alias members to the enum
257   pldm_pdr_repository_chg_event_change_record_event_data_operation.
258
259   enum constants with inconsistent names are deprecated with this change.
260   remove old inconsistent enum members after backward compatibility cleanup is
261   done
262
2638. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*`
2649. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type
26510. platform: Add 3 PDR type enum for Redfish Device Enablement per
266    DSP0248_1.2.0
26711. state_set: Add CONNECTED and DISCONNECTED enum for Link State set
26812. entity: Add enum for Network Interface Connectors and Network Ports
269    Connection Types
27013. pdr: Add decode_numeric_effecter_pdr_data()
27114. oem: ibm: Support for the Real SAI entity id
27215. fw_update: Add encode req & decode resp for query_downstream_devices
27316. fw_update: Add encode req & decode resp for query_downstream_identifiers
27417. platform: Add support for GetStateEffecterStates command
275
276### Changed
277
2781. base: Stabilise pldm_msg_hdr_correlate_response()
2792. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind()
2803. libpldm: Fix header use
2814. libpldm: More fixes for header use
2825. pdr: Stabilise pldm_pdr_find_last_in_range() API
2836. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle()
2847. oem: meta: stabilise decode_oem_meta_file_io_req()
2858. pdr: pldm_entity_association_tree_copy_root(): Document preconditions
286
287### Deprecated
288
2891. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed
290   with `PLDM_OEM_IBM_`
291
292### Fixed
293
2941. libpldm: Rationalise the local and installed path of pldm.h
2952. pdr: Assign record_handle in entity_association_pdr_add_children()
2963. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value()
2974. pdr: Remove redundant constant for minimum numeric sensor PDR length
2985. tests: oem: meta: Fix fileio use of msgbuf
299
300## [0.7.0] - 2023-08-29
301
302### Added
303
3041. state-set: Add new enum for Operational Fault Status enum
305
306### Changed
307
3081. transport: Match specified metadata in pldm_transport_send_recv_msg()
3092. transport: mctp-demux: Drop ABI annotation for internal symbols
3103. transport: Stabilise core transport and implementation APIs
311
312   This stabilisation covers the following headers and functions:
313
314   - libpldm/transport.h
315
316     - pldm_transport_poll()
317     - pldm_transport_send_msg()
318     - pldm_transport_recv_msg()
319     - pldm_transport_send_recv_msg()
320
321   - libpldm/transport/af-mctp.h
322
323     - pldm_transport_af_mctp_init()
324     - pldm_transport_af_mctp_destroy()
325     - pldm_transport_af_mctp_core()
326     - pldm_transport_af_mctp_init_pollfd()
327     - pldm_transport_af_mctp_map_tid()
328     - pldm_transport_af_mctp_unmap_tid()
329
330   - libpldm/transport/mctp-demux.h
331     - pldm_transport_mctp_demux_init()
332     - pldm_transport_mctp_demux_destroy()
333     - pldm_transport_mctp_demux_core()
334     - pldm_transport_mctp_demux_init_pollfd()
335     - pldm_transport_mctp_demux_map_tid()
336     - pldm_transport_mctp_demux_unmap_tid()
337
338### Deprecated
339
3401. All the existing "requester" APIs from `libpldm/pldm.h` (also known as
341   `libpldm/requester/pldm.h`):
342
343   - pldm_open()
344   - pldm_send_recv()
345   - pldm_send()
346   - pldm_recv()
347   - pldm_recv_any()
348   - pldm_close()
349
350   Users should migrate to the newer "transport" APIs instead.
351
352## Fixed
353
3541. tests: Exclude transport tests when build excludes testing ABIs
3552. abi: Capture deprecation of pldm_close()
356
357## [0.6.0] - 2023-08-22
358
359### Changed
360
3611. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity()
3622. meson: Apply `b_ndebug=if-release` by default
3633. pdr : Stabilize pldm_entity_association_tree_add_entity()
3644. pdr: Stabilise pldm_entity_association_tree_find_with_locality()
3655. pdr: Stabilize pldm_entity_node_get_remote_container_id()
3666. transport: af-mctp: Assign out-params on success in \*\_recv()
3677. transport: Generalise the pldm_transport_recv_msg() API
368
369### Removed
370
3711. pdr: Remove pldm_entity_association_pdr_add()
3722. state-set: Remove enum pldm_state_set_operational_fault_status_values
373
374### Fixed
375
3761. transport: register init_pollfd callback for af-mctp
3772. transport: fix init_pollfd function parameter
3783. transport: Fix doxygen and variables for send and recv functions
3794. transport: af-mctp: Ensure malloc() succeeds in \*\_recv()
380
381## [0.5.0] - 2023-08-09
382
383### Added
384
3851. pdr: Introduce pldm_entity_association_pdr_add_check()
386
387### Changed
388
3891. pdr: Allow record_handle to be NULL for pldm_pdr_add_check()
3902. transport: pldm_transport_poll(): Adjust return value semantics
3913. transport: free un-wanted responses in pldm_transport_send_recv_msg()
392
393### Deprecated
394
3951. state-set: Enum pldm_state_set_operational_fault_status_values
396
397   The enum operational_fault_status is defined with wrong members and will
398   eventually be replaced with the correct members. Any uses of
399   pldm_state_set_operational_fault_status_values members should move to
400   equivalent pldm_state_set_operational_stress_status_values members if needed.
401
4022. platform: Struct field name in fru_record_set PDR
403
404   References to entity_instance_num should be changed to entity_instance
405
4063. platform: Struct field name in numeric sensor value PDR
407
408   References to entity_instance_num should be changed to entity_instance
409
410### Removed
411
4121. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length()
4132. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum()
4143. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string()
4154. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer()
4165. bios_table: Remove pldm_bios_table_append_pad_checksum()
4176. fru: Remove get_fru_record_by_option()
4187. pdr: Make is_present() static
4198. pdr: Remove pldm_pdr_add()
4209. pdr: Remove pldm_pdr_add_fru_record_set()
42110. pdr: Remove pldm_entity_association_pdr_add_from_node()
42211. pdr: Make find_entity_ref_in_tree() static
42312. pdr: Make entity_association_tree_find() static
424
425### Fixed
426
4271. requester: Fix response buffer cast in pldm_send_recv()
4282. pdr: Hoist record handle overflow test to avoid memory leak
4293. transport: Correct comparison in while loop condition
430
431## [0.4.0] - 2023-07-14
432
433### Added
434
4351. bios_table: Introduce pldm_bios_table_append_pad_checksum_check()
4362. fru: Introduce get_fru_record_by_option_check()
4373. pdr: Introduce pldm_entity_association_pdr_add_from_node_check()
4384. pdr: Introduce pldm_pdr_add_check()
4395. pdr: Introduce pldm_pdr_add_fru_record_set_check()
440
441### Changed
442
4431. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING
4442. requester: Expose pldm_close() in header
4453. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow
4464. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc
4475. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration
4486. pdr: pldm_pdr_init(): Return NULL on allocation failure
4497. pdr: pldm_pdr_destroy(): Exit early if repo is NULL
4508. pdr: Document preconditions for trivial accessor functions
451
452   A trivial accessor function is one that exposes properties of an object in a
453   way can't result in an error, beyond passing an invalid argument to the
454   function. For APIs meeting this definition we define a precondition that
455   struct pointers must point to valid objects to avoid polluting the function
456   prototypes. The following APIs now have this precondition explicitly defined:
457
458   - pldm_entity_extract()
459   - pldm_entity_get_parent()
460   - pldm_entity_is_exist_parent()
461   - pldm_entity_is_node_parent()
462   - pldm_is_current_parent_child
463   - pldm_is_empty_entity_assoc_tree()
464   - pldm_pdr_get_record_count()
465   - pldm_pdr_get_record_handle()
466   - pldm_pdr_get_repo_size()
467   - pldm_pdr_record_is_remote()
468
4699. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor
47010. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments
47111. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc
47212. pdr: pldm_entity_association_tree_visit(): Document preconditions
47313. pdr: pldm_entity_association_tree_visit(): Exit early on failure
47414. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument
47515. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments
47616. pdr: pldm_is_current_parent_child(): Return false for invalid arguments
47717. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments
47818. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments
47919. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments
48020. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg
48121. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments
48222. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit
48323. pdr: pldm_entity_get_num_children(): Don't return invalid values
48424. libpldm: Lift or remove asserts where a subsequent check exists
485
486### Deprecated
487
4881. pldm_bios_table_attr_entry_integer_encode()
489
490   Migrate to pldm_bios_table_attr_entry_integer_encode_check()
491
4922. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum()
493
494   Migrate to pldm_bios_table_attr_value_entry_encode_enum_check()
495
4963. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string()
497
498   Migrate to pldm_bios_table_attr_value_entry_encode_string_check()
499
5004. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer()
501
502   Migrate to pldm_bios_table_attr_value_entry_encode_integer_check()
503
5045. pdr: Deprecate is_present()
505
506   There should be no users of this symbol. If you are a user, you should figure
507   out how to stop, or get in touch. This symbol will be marked static the
508   release after deprecation.
509
5106. pdr: Deprecate find_entity_ref_in_tree()
511
512   There should be no users of this symbol. If you are a user, you should figure
513   out how to stop, or get in touch. This symbol will be marked static the
514   release after deprecation.
515
5167. pdr: Deprecate entity_association_tree_find()
517
518   There should be no users of this symbol. If you are a user, you should figure
519   out how to stop, or get in touch. This symbol will be marked static the
520   release after deprecation.
521
5228. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check()
523
524   pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of
525   pldm_bios_table_append_pad_checksum() should migrate to
526   pldm_bios_table_append_pad_checksum_check()
527
5289. fru: Stabilise get_fru_record_by_option_check()
529
530   get_fru_record_by_option() is deprecated by this change. Users of
531   get_fru_record_by_option() should migrate to get_fru_record_by_option_check()
532
53310. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check()
534
535    pldm_entity_association_pdr_add_from_node() is deprecated by this change.
536    Users of pldm_entity_association_pdr_add_from_node() should migrate to
537    pldm_entity_association_pdr_add_from_node_check()
538
53911. pdr: Stabilise pldm_pdr_add_check()
540
541    pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should
542    migrate to pldm_pdr_add_check()
543
54412. pdr: Stabilise pldm_pdr_add_fru_record_set_check()
545
546    pldm_pdr_add_fru_record_set() is deprecated by this change. Users of
547    pldm_pdr_add_fru_record_set() should migrate to
548    pldm_pdr_add_fru_record_set_check()
549
550### Removed
551
5521. bios_table: Remove deprecated APIs sanitized by assert():
553
554   - pldm_bios_table_string_entry_encode()
555   - pldm_bios_table_string_entry_decode_string()
556   - pldm_bios_table_attr_entry_enum_encode()
557   - pldm_bios_table_attr_entry_enum_decode_pv_num()
558   - pldm_bios_table_attr_entry_enum_decode_def_num()
559   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
560   - pldm_bios_table_attr_entry_string_encode()
561   - pldm_bios_table_attr_entry_string_decode_def_string_length()
562
563### Fixed
564
5651. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API
5662. pdr: Rework pldm_pdr_find_container_id_range_exclude() API
5673. transport: mctp-demux: Don't test socket for non-zero value
5684. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error
5695. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return
5706. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init()
5717. abi: Update to remove pldm_close() from reference dumps
5728. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer()
573
574## [0.3.0] - 2023-06-23
575
576### Added
577
5781. Add encode/decode pldmMessagePollEvent data
5792. README: Add a section on working with libpldm
5803. pdr: Introduce remote_container_id and associated APIs
5814. pdr: Add APIs for creating and locating remote PDRs
5825. pdr: Add pldm_pdr_find_last_in_range()
5836. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle()
5847. pdr: Add pldm_pdr_find_container_id_range_exclude()
585
586### Changed
587
5881. include: Move installed transport.h under libpldm/
5892. libpldm: Explicit deprecated, stable and testing ABI classes
5903. meson: Reduce strength of oem-ibm requirements from enabled to allowed
591
592   The `oem-ibm` feature is now enabled by the default meson configuration, for
593   CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake
594   recipe:
595
596   <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10>
597
598   To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled`
599   when invoking `meson setup`
600
6014. bios_table: Relax pldm_bios_table_string_entry_decode_string_check()
6025. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()
603
604### Deprecated
605
6061. bios_table: Deprecate APIs with arguments sanitized using assert()
607
608   C provides enough foot-guns without us encoding them into library APIs.
609   Specifically, deprecate the following in favour of their `*_check()` variants
610   which ensure assertions won't fail or otherwise invoke UB:
611
612   - pldm_bios_table_string_entry_encode()
613   - pldm_bios_table_string_entry_decode_string()
614   - pldm_bios_table_attr_entry_enum_encode()
615   - pldm_bios_table_attr_entry_enum_decode_pv_num()
616   - pldm_bios_table_attr_entry_enum_decode_def_num()
617   - pldm_bios_table_attr_entry_enum_decode_pv_hdls()
618   - pldm_bios_table_attr_entry_string_encode()
619   - pldm_bios_table_attr_entry_string_decode_def_string_length()
620
621### Removed
622
6231. libpldm: Remove the requester-api option
624
625### Fixed
626
6271. requester: Make pldm_open() return existing fd
6282. transport: Prevent sticking in waiting for response
6293. transport: Match on response in pldm_transport_send_recv_msg()
6304. requester: Add check before accessing hdr in pldm_recv()
6315. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref
632