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. dsp: firmware_update: Iterators for downstream device descriptors 232. platform: add PLDM Command numbers 24 25### Changed 26 271. Register assignment for parameters of `encode_state_effecter_pdr()` 28 292. dsp: firmware_update: Iterators for downstream device descriptors 30 31 The prototype for `decode_query_downstream_identifiers_resp()` was updated to 32 improve ergonomics for the iterator APIs. 33 34### Fixed 35 361. dsp: platform: Fix location of closing paren in overflow detection 372. libpldm: Install api header, update changelog 38 39## [0.10.0] 2024-11-01 40 41### Added 42 431. oem: meta: Add decode_oem_meta_file_io_write_req() 442. oem: meta: Add decode_oem_meta_file_io_read_req() 453. oem: meta: Add encode_oem_meta_file_io_read_resp() 464. pdr: Add pldm_entity_association_pdr_remove_contained_entity() 475. pdr: Add pldm_pdr_remove_fru_record_set_by_rsi() 486. pldm_entity_association_tree_copy_root_check() 497. oem: ibm: Add topology related state set and enum 50 518. base: Add size and buffer macros for struct pldm_msg 52 53 Together these macros reduce the need for use of reinterpret_cast<>() in C++. 54 559. entity: Add new entity types from DSP0249 v1.3.0 5610. stateset: Add new state sets from DSP0249 v1.3.0 57 58### Changed 59 601. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 61 62 pldm_bios_table_iter_is_end() now returns true if the provided argument is 63 NULL. 64 652. Register assignment for parameters of a number of APIs changed with increased 66 scrutiny on their implementations. 67 68 - `decode_entity_auxiliary_names_pdr()` 69 - `decode_get_state_sensor_readings_resp()` 70 - `decode_oem_meta_file_io_req()` 71 - `decode_platform_event_message_req()` 72 - `decode_platform_event_message_resp()` 73 - `decode_sensor_op_data()` 74 - `encode_get_state_effecter_states_resp()` 75 - `encode_state_effecter_pdr()` 76 - `encode_state_sensor_pdr()` 77 - `pldm_bios_table_append_pad_checksum()` 78 - `pldm_bios_table_attr_value_entry_encode_enum()` 79 - `pldm_bios_table_attr_value_entry_encode_string()` 80 - `pldm_pdr_find_record()` 81 - `pldm_pdr_get_next_record()` 82 833. platform: Support PLDM_CPER_EVENT in encode_platform_event_message_req() 84 854. dsp: firmware_update: Bounds check 86 decode_downstream_device_parameter_table_entry_versions() 87 88 The additional bounds-checking required the addition of further length 89 parameters. 90 91### Deprecated 92 931. oem: meta: Deprecate `decode_oem_meta_file_io_req()` 94 95 Users should switch to `decode_oem_meta_file_io_write_req()`. Modify this 96 function to make it safer. 97 98 Modification: 99 100 - The meaning of the returned result. 101 - Change parameters from individual pointers to a struct. 102 - Check the length provided in the message won't exceed the buffer. 103 1042. pldm_entity_association_tree_copy_root() 105 106 The implementation allocates, but gives no indication to the caller if an 107 allocation (and hence the copy) has failed. Users should migrate to 108 pldm_entity_association_tree_copy_root_check(). 109 1103. The following APIs are deprecated as unsafe due to various unfixable CWE 111 violations: 112 113 - [CWE-129: Improper Validation of Array Index](https://cwe.mitre.org/data/definitions/129.html) 114 115 - `encode_get_bios_current_value_by_handle_resp()` 116 - `encode_get_bios_table_resp()` 117 - `encode_get_file_table_resp()` 118 - `encode_get_version_resp()` 119 - `pldm_bios_table_attr_entry_enum_decode_def_indices()` 120 - `pldm_bios_table_attr_entry_enum_decode_def_num()` 121 - `pldm_bios_table_attr_find_by_handle()` 122 - `pldm_bios_table_attr_find_by_string_handle()` 123 - `pldm_bios_table_attr_value_find_by_handle()` 124 - `pldm_bios_table_iter_create()` 125 - `pldm_bios_table_iter_is_end()` 126 - `pldm_bios_table_string_find_by_handle()` 127 - `pldm_bios_table_string_find_by_string()` 128 129 - [CWE-617: Reachable Assertion](https://cwe.mitre.org/data/definitions/617.html) 130 131 - `pldm_entity_association_tree_copy_root()` 132 133 - [CWE-789: Memory Allocation with Excessive Size Value](https://cwe.mitre.org/data/definitions/789.html) 134 135 - `decode_oem_meta_file_io_req()` 136 137 - [CWE-823: Use of Out-of-range Pointer Offset](https://cwe.mitre.org/data/definitions/823.html) 138 - `encode_fru_record()` 139 - `encode_get_pdr_resp()` 140 - `pldm_bios_table_attr_entry_enum_encode_length()` 141 142### Removed 143 1441. Deprecated functions with the `_check` suffix 145 146 - `get_fru_record_by_option_check()` 147 - `pldm_bios_table_append_pad_checksum_check()` 148 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 149 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 150 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 151 - `pldm_bios_table_attr_entry_enum_encode_check()` 152 - `pldm_bios_table_attr_entry_integer_encode_check()` 153 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 154 - `pldm_bios_table_attr_entry_string_encode_check()` 155 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 156 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 157 - `pldm_bios_table_attr_value_entry_encode_string_check()` 158 - `pldm_bios_table_string_entry_decode_string_check()` 159 - `pldm_bios_table_string_entry_encode_check()` 160 - `pldm_entity_association_pdr_add_check()` 161 - `pldm_entity_association_pdr_add_from_node_check()` 162 - `pldm_pdr_add_check()` 163 - `pldm_pdr_add_fru_record_set_check()` 164 165### Fixed 166 1671. dsp: bios_table: Null check for pldm_bios_table_iter_is_end() 168 169 Avoid a caller-controlled NULL pointer dereference in the library 170 implementation. 171 1722. platform: fix encode/decode_poll_for_platform_event_message_req 173 174 Update checking of `TransferOperationFlag` and `eventIDToAcknowledge` to 175 follow spec. 176 1773. platform: Fix checking `eventIDToAcknowledge` 178 179 As the event receiver sends `PollForPlatformEventMessage` with the 180 `tranferFlag` is `AcknowledgementOnly`, the value `eventIDToAcknowledge` 181 should be the previously retrieved eventID (from the PLDM terminus). 182 1834. dsp: platform: Prevent overflow of arithmetic on event_data_length 1845. dsp: platform: Bounds check encode_sensor_state_pdr() 1856. dsp: platform: Bounds check encode_state_effecter_pdr() 1867. dsp: pdr: Bounds check pldm_entity_association_pdr_extract() 1878. dsp: bios_table: Bounds check pldm_bios_table_append_pad_checksum() 1889. dsp: bios_table: Bounds check 189 pldm_bios_table_attr_value_entry_encode_string() 19010. dsp: bios_table: Bounds check pldm_bios_table_attr_value_entry_encode_enum() 19111. dsp: firmware_update: Bounds check 192 decode_downstream_device_parameter_table_entry_versions() 19312. oem: ibm: platform: Bounds check encode_bios_attribute_update_event_req() 19413. dsp: fru: Bounds check encode_get_fru_record_by_option_resp() 19514. dsp: fru: Bounds check encode_fru_record() 19615. dsp: bios: Bounds check encode_set_bios_table_req() 19716. dsp: bios: Bounds check encode_set_bios_attribute_current_value_req() 19817. dsp: bios_table: Bounds check pldm_bios_table_string_entry_encode() 19918. dsp: pdr: Rework test in pldm_entity_association_pdr_extract() 20019. dsp: platform: Fix decode_set_event_receiver_req() 201 202## [0.9.1] - 2024-09-07 203 204### Changed 205 2061. Moved evolutions intended for v0.9.0 into place 207 208 Evolutions for the release have been moved from `evolutions/current` to 209 `evolutions/v0.9.1`. Library users can apply them to migrate off of 210 deprecated APIs. 211 212## [0.9.0] - 2024-09-07 213 214### Added 215 2161. base: Define macros for reserved TIDs 2172. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 2183. pdr: Add pldm_entity_association_pdr_create_new() 2194. platform: Define macros for the responded transferflags 2205. pdr: Add pldm_pdr_get_terminus_handle() API 2216. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 2227. fw_update: Add encode req & decode resp for get_downstream_fw_params 2238. platform: Add decode_pldm_platform_cper_event() API 2249. decode_get_pdr_repository_info_resp_safe() 225 226 Replaces decode_get_pdr_repository_info_resp() as discussed in the 227 `Deprecated` section below 228 22910. decode_get_pdr_resp_safe() 230 231 Replaces decode_get_pdr_resp() as discussed in the `Deprecated` section 232 below 233 234### Changed 235 2361. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 2372. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 2383. platform: Stabilise decode_pldm_message_poll_event_data() APIs 2394. ABI break for decode_sensor_op_data() 240 241 Applying LIBPLDM_CC_NONNULL to the internal msgbuf APIs caused 242 abi-compliance-checker to flag a change in the register containing the 243 parameter `previous_op_state`. 244 2455. platform: Stabilise decode_pldm_platform_cper_event() API 2466. oem: meta: Stabilise decode_oem_meta_file_io_write_req() API 2477. oem: meta: Stabilise decode_oem_meta_file_io_read_req() API 2488. oem: meta: Stabilise encode_oem_meta_file_io_read_resp() API 249 250### Deprecated 251 2521. Rename and deprecate functions with the `_check` suffix 253 254 All library function return values always need to be checked. The `_check` 255 suffix is redundant, so remove it. Migration to the non-deprecated 256 equivalents without the `_check` suffix can be performed using 257 `scripts/ apply-renames` and the [clang-rename][] configurations under 258 `evolutions/` 259 260 The deprecated functions: 261 262 - `get_fru_record_by_option_check()` 263 - `pldm_bios_table_append_pad_checksum_check()` 264 - `pldm_bios_table_attr_entry_enum_decode_def_num_check()` 265 - `pldm_bios_table_attr_entry_enum_decode_pv_hdls_check()` 266 - `pldm_bios_table_attr_entry_enum_decode_pv_num_check()` 267 - `pldm_bios_table_attr_entry_enum_encode_check()` 268 - `pldm_bios_table_attr_entry_integer_encode_check()` 269 - `pldm_bios_table_attr_entry_string_decode_def_string_length_check()` 270 - `pldm_bios_table_attr_entry_string_encode_check()` 271 - `pldm_bios_table_attr_value_entry_encode_enum_check()` 272 - `pldm_bios_table_attr_value_entry_encode_integer_check()` 273 - `pldm_bios_table_attr_value_entry_encode_string_check()` 274 - `pldm_bios_table_string_entry_decode_string_check()` 275 - `pldm_bios_table_string_entry_encode_check()` 276 - `pldm_entity_association_pdr_add_check()` 277 - `pldm_entity_association_pdr_add_from_node_check()` 278 - `pldm_pdr_add_check()` 279 - `pldm_pdr_add_fru_record_set_check()` 280 281[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 282 2832. `decode_get_pdr_repository_info_resp()` 284 285 Users should move to `decode_get_pdr_repository_info_resp_safe()` which 286 eliminates the opportunity for buffer overruns when extracting objects from 287 the message. 288 2893. `decode_get_pdr_resp()` 290 291 Users should move to `decode_get_pdr_resp_safe()` which reduces the 292 invocation tedium and improves memory safety over `decode_get_pdr_resp()`. 293 294### Removed 295 2961. IBM OEM header compatibility symlinks. 297 298 Anyone left using the deprecated paths can migrate using the coccinelle patch 299 at `evolutions/current/oem-ibm-header-compat.cocci`. 300 301### Fixed 302 3031. requester: instance-id: Release read lock on conflict 3042. pdr: Error propagation for 305 pldm_entity_association_pdr_add_from_node_with_record_handle() 306 307## [0.8.0] - 2024-05-23 308 309### Added 310 3111. base: Provide pldm_msg_hdr_correlate_response() 3122. transport: af-mctp: Add pldm_transport_af_mctp_bind() 3133. oem: ibm: Add chapdata file type support 3144. base: Added PLDM_SMBIOS & PLDM_RDE message types 3155. oem: meta: Add decode_oem_meta_file_io_req() 3166. state-set: Add all state set values to system power state enum as per DSP0249 3177. platform: Add alias members to the enum 318 pldm_pdr_repository_chg_event_change_record_event_data_operation. 319 320 enum constants with inconsistent names are deprecated with this change. 321 remove old inconsistent enum members after backward compatibility cleanup is 322 done 323 3248. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 3259. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 32610. platform: Add 3 PDR type enum for Redfish Device Enablement per 327 DSP0248_1.2.0 32811. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 32912. entity: Add enum for Network Interface Connectors and Network Ports 330 Connection Types 33113. pdr: Add decode_numeric_effecter_pdr_data() 33214. oem: ibm: Support for the Real SAI entity id 33315. fw_update: Add encode req & decode resp for query_downstream_devices 33416. fw_update: Add encode req & decode resp for query_downstream_identifiers 33517. platform: Add support for GetStateEffecterStates command 336 337### Changed 338 3391. base: Stabilise pldm_msg_hdr_correlate_response() 3402. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 3413. libpldm: Fix header use 3424. libpldm: More fixes for header use 3435. pdr: Stabilise pldm_pdr_find_last_in_range() API 3446. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 3457. oem: meta: stabilise decode_oem_meta_file_io_req() 3468. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 347 348### Deprecated 349 3501. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 351 with `PLDM_OEM_IBM_` 352 353### Fixed 354 3551. libpldm: Rationalise the local and installed path of pldm.h 3562. pdr: Assign record_handle in entity_association_pdr_add_children() 3573. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 3584. pdr: Remove redundant constant for minimum numeric sensor PDR length 3595. tests: oem: meta: Fix fileio use of msgbuf 360 361## [0.7.0] - 2023-08-29 362 363### Added 364 3651. state-set: Add new enum for Operational Fault Status enum 366 367### Changed 368 3691. transport: Match specified metadata in pldm_transport_send_recv_msg() 3702. transport: mctp-demux: Drop ABI annotation for internal symbols 3713. transport: Stabilise core transport and implementation APIs 372 373 This stabilisation covers the following headers and functions: 374 375 - libpldm/transport.h 376 377 - pldm_transport_poll() 378 - pldm_transport_send_msg() 379 - pldm_transport_recv_msg() 380 - pldm_transport_send_recv_msg() 381 382 - libpldm/transport/af-mctp.h 383 384 - pldm_transport_af_mctp_init() 385 - pldm_transport_af_mctp_destroy() 386 - pldm_transport_af_mctp_core() 387 - pldm_transport_af_mctp_init_pollfd() 388 - pldm_transport_af_mctp_map_tid() 389 - pldm_transport_af_mctp_unmap_tid() 390 391 - libpldm/transport/mctp-demux.h 392 - pldm_transport_mctp_demux_init() 393 - pldm_transport_mctp_demux_destroy() 394 - pldm_transport_mctp_demux_core() 395 - pldm_transport_mctp_demux_init_pollfd() 396 - pldm_transport_mctp_demux_map_tid() 397 - pldm_transport_mctp_demux_unmap_tid() 398 399### Deprecated 400 4011. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 402 `libpldm/requester/pldm.h`): 403 404 - pldm_open() 405 - pldm_send_recv() 406 - pldm_send() 407 - pldm_recv() 408 - pldm_recv_any() 409 - pldm_close() 410 411 Users should migrate to the newer "transport" APIs instead. 412 413## Fixed 414 4151. tests: Exclude transport tests when build excludes testing ABIs 4162. abi: Capture deprecation of pldm_close() 417 418## [0.6.0] - 2023-08-22 419 420### Changed 421 4221. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 4232. meson: Apply `b_ndebug=if-release` by default 4243. pdr : Stabilize pldm_entity_association_tree_add_entity() 4254. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 4265. pdr: Stabilize pldm_entity_node_get_remote_container_id() 4276. transport: af-mctp: Assign out-params on success in \*\_recv() 4287. transport: Generalise the pldm_transport_recv_msg() API 429 430### Removed 431 4321. pdr: Remove pldm_entity_association_pdr_add() 4332. state-set: Remove enum pldm_state_set_operational_fault_status_values 434 435### Fixed 436 4371. transport: register init_pollfd callback for af-mctp 4382. transport: fix init_pollfd function parameter 4393. transport: Fix doxygen and variables for send and recv functions 4404. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 441 442## [0.5.0] - 2023-08-09 443 444### Added 445 4461. pdr: Introduce pldm_entity_association_pdr_add_check() 447 448### Changed 449 4501. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 4512. transport: pldm_transport_poll(): Adjust return value semantics 4523. transport: free un-wanted responses in pldm_transport_send_recv_msg() 453 454### Deprecated 455 4561. state-set: Enum pldm_state_set_operational_fault_status_values 457 458 The enum operational_fault_status is defined with wrong members and will 459 eventually be replaced with the correct members. Any uses of 460 pldm_state_set_operational_fault_status_values members should move to 461 equivalent pldm_state_set_operational_stress_status_values members if needed. 462 4632. platform: Struct field name in fru_record_set PDR 464 465 References to entity_instance_num should be changed to entity_instance 466 4673. platform: Struct field name in numeric sensor value PDR 468 469 References to entity_instance_num should be changed to entity_instance 470 471### Removed 472 4731. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 4742. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 4753. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 4764. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 4775. bios_table: Remove pldm_bios_table_append_pad_checksum() 4786. fru: Remove get_fru_record_by_option() 4797. pdr: Make is_present() static 4808. pdr: Remove pldm_pdr_add() 4819. pdr: Remove pldm_pdr_add_fru_record_set() 48210. pdr: Remove pldm_entity_association_pdr_add_from_node() 48311. pdr: Make find_entity_ref_in_tree() static 48412. pdr: Make entity_association_tree_find() static 485 486### Fixed 487 4881. requester: Fix response buffer cast in pldm_send_recv() 4892. pdr: Hoist record handle overflow test to avoid memory leak 4903. transport: Correct comparison in while loop condition 491 492## [0.4.0] - 2023-07-14 493 494### Added 495 4961. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 4972. fru: Introduce get_fru_record_by_option_check() 4983. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 4994. pdr: Introduce pldm_pdr_add_check() 5005. pdr: Introduce pldm_pdr_add_fru_record_set_check() 501 502### Changed 503 5041. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 5052. requester: Expose pldm_close() in header 5063. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 5074. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 5085. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 5096. pdr: pldm_pdr_init(): Return NULL on allocation failure 5107. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 5118. pdr: Document preconditions for trivial accessor functions 512 513 A trivial accessor function is one that exposes properties of an object in a 514 way can't result in an error, beyond passing an invalid argument to the 515 function. For APIs meeting this definition we define a precondition that 516 struct pointers must point to valid objects to avoid polluting the function 517 prototypes. The following APIs now have this precondition explicitly defined: 518 519 - pldm_entity_extract() 520 - pldm_entity_get_parent() 521 - pldm_entity_is_exist_parent() 522 - pldm_entity_is_node_parent() 523 - pldm_is_current_parent_child 524 - pldm_is_empty_entity_assoc_tree() 525 - pldm_pdr_get_record_count() 526 - pldm_pdr_get_record_handle() 527 - pldm_pdr_get_repo_size() 528 - pldm_pdr_record_is_remote() 529 5309. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 53110. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 53211. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 53312. pdr: pldm_entity_association_tree_visit(): Document preconditions 53413. pdr: pldm_entity_association_tree_visit(): Exit early on failure 53514. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 53615. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 53716. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 53817. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 53918. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 54019. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 54120. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 54221. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 54322. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 54423. pdr: pldm_entity_get_num_children(): Don't return invalid values 54524. libpldm: Lift or remove asserts where a subsequent check exists 546 547### Deprecated 548 5491. pldm_bios_table_attr_entry_integer_encode() 550 551 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 552 5532. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 554 555 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 556 5573. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 558 559 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 560 5614. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 562 563 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 564 5655. pdr: Deprecate is_present() 566 567 There should be no users of this symbol. If you are a user, you should figure 568 out how to stop, or get in touch. This symbol will be marked static the 569 release after deprecation. 570 5716. pdr: Deprecate find_entity_ref_in_tree() 572 573 There should be no users of this symbol. If you are a user, you should figure 574 out how to stop, or get in touch. This symbol will be marked static the 575 release after deprecation. 576 5777. pdr: Deprecate entity_association_tree_find() 578 579 There should be no users of this symbol. If you are a user, you should figure 580 out how to stop, or get in touch. This symbol will be marked static the 581 release after deprecation. 582 5838. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 584 585 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 586 pldm_bios_table_append_pad_checksum() should migrate to 587 pldm_bios_table_append_pad_checksum_check() 588 5899. fru: Stabilise get_fru_record_by_option_check() 590 591 get_fru_record_by_option() is deprecated by this change. Users of 592 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 593 59410. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 595 596 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 597 Users of pldm_entity_association_pdr_add_from_node() should migrate to 598 pldm_entity_association_pdr_add_from_node_check() 599 60011. pdr: Stabilise pldm_pdr_add_check() 601 602 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 603 migrate to pldm_pdr_add_check() 604 60512. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 606 607 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 608 pldm_pdr_add_fru_record_set() should migrate to 609 pldm_pdr_add_fru_record_set_check() 610 611### Removed 612 6131. bios_table: Remove deprecated APIs sanitized by assert(): 614 615 - pldm_bios_table_string_entry_encode() 616 - pldm_bios_table_string_entry_decode_string() 617 - pldm_bios_table_attr_entry_enum_encode() 618 - pldm_bios_table_attr_entry_enum_decode_pv_num() 619 - pldm_bios_table_attr_entry_enum_decode_def_num() 620 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 621 - pldm_bios_table_attr_entry_string_encode() 622 - pldm_bios_table_attr_entry_string_decode_def_string_length() 623 624### Fixed 625 6261. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 6272. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 6283. transport: mctp-demux: Don't test socket for non-zero value 6294. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 6305. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 6316. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 6327. abi: Update to remove pldm_close() from reference dumps 6338. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 634 635## [0.3.0] - 2023-06-23 636 637### Added 638 6391. Add encode/decode pldmMessagePollEvent data 6402. README: Add a section on working with libpldm 6413. pdr: Introduce remote_container_id and associated APIs 6424. pdr: Add APIs for creating and locating remote PDRs 6435. pdr: Add pldm_pdr_find_last_in_range() 6446. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 6457. pdr: Add pldm_pdr_find_container_id_range_exclude() 646 647### Changed 648 6491. include: Move installed transport.h under libpldm/ 6502. libpldm: Explicit deprecated, stable and testing ABI classes 6513. meson: Reduce strength of oem-ibm requirements from enabled to allowed 652 653 The `oem-ibm` feature is now enabled by the default meson configuration, for 654 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 655 recipe: 656 657 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 658 659 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 660 when invoking `meson setup` 661 6624. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 6635. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 664 665### Deprecated 666 6671. bios_table: Deprecate APIs with arguments sanitized using assert() 668 669 C provides enough foot-guns without us encoding them into library APIs. 670 Specifically, deprecate the following in favour of their `*_check()` variants 671 which ensure assertions won't fail or otherwise invoke UB: 672 673 - pldm_bios_table_string_entry_encode() 674 - pldm_bios_table_string_entry_decode_string() 675 - pldm_bios_table_attr_entry_enum_encode() 676 - pldm_bios_table_attr_entry_enum_decode_pv_num() 677 - pldm_bios_table_attr_entry_enum_decode_def_num() 678 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 679 - pldm_bios_table_attr_entry_string_encode() 680 - pldm_bios_table_attr_entry_string_decode_def_string_length() 681 682### Removed 683 6841. libpldm: Remove the requester-api option 685 686### Fixed 687 6881. requester: Make pldm_open() return existing fd 6892. transport: Prevent sticking in waiting for response 6903. transport: Match on response in pldm_transport_send_recv_msg() 6914. requester: Add check before accessing hdr in pldm_recv() 6925. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 693