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## [0.8.0] - 2024-05-23 21 22### Added 23 241. base: Provide pldm_msg_hdr_correlate_response() 252. transport: af-mctp: Add pldm_transport_af_mctp_bind() 263. oem: ibm: Add chapdata file type support 274. base: Added PLDM_SMBIOS & PLDM_RDE message types 285. oem: meta: Add decode_oem_meta_file_io_req() 296. state-set: Add all state set values to system power state enum as per DSP0249 307. platform: Add alias members to the enum 31 pldm_pdr_repository_chg_event_change_record_event_data_operation. 32 33 enum constants with inconsistent names are deprecated with this change. 34 remove old inconsistent enum members after backward compatibility cleanup is 35 done 36 378. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 389. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 3910. platform: Add 3 PDR type enum for Redfish Device Enablement per 40 DSP0248_1.2.0 4111. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 4212. entity: Add enum for Network Interface Connectors and Network Ports 43 Connection Types 4413. pdr: Add decode_numeric_effecter_pdr_data() 4514. oem: ibm: Support for the Real SAI entity id 4615. fw_update: Add encode req & decode resp for query_downstream_devices 4716. fw_update: Add encode req & decode resp for query_downstream_identifiers 4817. platform: Add support for GetStateEffecterStates command 49 50### Changed 51 521. base: Stabilise pldm_msg_hdr_correlate_response() 532. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 543. libpldm: Fix header use 554. libpldm: More fixes for header use 565. pdr: Stabilise pldm_pdr_find_last_in_range() API 576. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 587. oem: meta: stabilise decode_oem_meta_file_io_req() 598. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 60 61### Deprecated 62 631. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 64 with `PLDM_OEM_IBM_` 65 66### Fixed 67 681. libpldm: Rationalise the local and installed path of pldm.h 692. pdr: Assign record_handle in entity_association_pdr_add_children() 703. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 714. pdr: Remove redundant constant for minimum numeric sensor PDR length 725. tests: oem: meta: Fix fileio use of msgbuf 73 74## [0.7.0] - 2023-08-29 75 76### Added 77 781. state-set: Add new enum for Operational Fault Status enum 79 80### Changed 81 821. transport: Match specified metadata in pldm_transport_send_recv_msg() 832. transport: mctp-demux: Drop ABI annotation for internal symbols 843. transport: Stabilise core transport and implementation APIs 85 86 This stabilisation covers the following headers and functions: 87 88 - libpldm/transport.h 89 90 - pldm_transport_poll() 91 - pldm_transport_send_msg() 92 - pldm_transport_recv_msg() 93 - pldm_transport_send_recv_msg() 94 95 - libpldm/transport/af-mctp.h 96 97 - pldm_transport_af_mctp_init() 98 - pldm_transport_af_mctp_destroy() 99 - pldm_transport_af_mctp_core() 100 - pldm_transport_af_mctp_init_pollfd() 101 - pldm_transport_af_mctp_map_tid() 102 - pldm_transport_af_mctp_unmap_tid() 103 104 - libpldm/transport/mctp-demux.h 105 - pldm_transport_mctp_demux_init() 106 - pldm_transport_mctp_demux_destroy() 107 - pldm_transport_mctp_demux_core() 108 - pldm_transport_mctp_demux_init_pollfd() 109 - pldm_transport_mctp_demux_map_tid() 110 - pldm_transport_mctp_demux_unmap_tid() 111 112### Deprecated 113 1141. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 115 `libpldm/requester/pldm.h`): 116 117 - pldm_open() 118 - pldm_send_recv() 119 - pldm_send() 120 - pldm_recv() 121 - pldm_recv_any() 122 - pldm_close() 123 124 Users should migrate to the newer "transport" APIs instead. 125 126## Fixed 127 1281. tests: Exclude transport tests when build excludes testing ABIs 1292. abi: Capture deprecation of pldm_close() 130 131## [0.6.0] - 2023-08-22 132 133### Changed 134 1351. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1362. meson: Apply `b_ndebug=if-release` by default 1373. pdr : Stabilize pldm_entity_association_tree_add_entity() 1384. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 1395. pdr: Stabilize pldm_entity_node_get_remote_container_id() 1406. transport: af-mctp: Assign out-params on success in \*\_recv() 1417. transport: Generalise the pldm_transport_recv_msg() API 142 143### Removed 144 1451. pdr: Remove pldm_entity_association_pdr_add() 1462. state-set: Remove enum pldm_state_set_operational_fault_status_values 147 148### Fixed 149 1501. transport: register init_pollfd callback for af-mctp 1512. transport: fix init_pollfd function parameter 1523. transport: Fix doxygen and variables for send and recv functions 1534. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 154 155## [0.5.0] - 2023-08-09 156 157### Added 158 1591. pdr: Introduce pldm_entity_association_pdr_add_check() 160 161### Changed 162 1631. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 1642. transport: pldm_transport_poll(): Adjust return value semantics 1653. transport: free un-wanted responses in pldm_transport_send_recv_msg() 166 167### Deprecated 168 1691. state-set: Enum pldm_state_set_operational_fault_status_values 170 171 The enum operational_fault_status is defined with wrong members and will 172 eventually be replaced with the correct members. Any uses of 173 pldm_state_set_operational_fault_status_values members should move to 174 equivalent pldm_state_set_operational_stress_status_values members if needed. 175 1762. platform: Struct field name in fru_record_set PDR 177 178 References to entity_instance_num should be changed to entity_instance 179 1803. platform: Struct field name in numeric sensor value PDR 181 182 References to entity_instance_num should be changed to entity_instance 183 184### Removed 185 1861. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 1872. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 1883. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 1894. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 1905. bios_table: Remove pldm_bios_table_append_pad_checksum() 1916. fru: Remove get_fru_record_by_option() 1927. pdr: Make is_present() static 1938. pdr: Remove pldm_pdr_add() 1949. pdr: Remove pldm_pdr_add_fru_record_set() 19510. pdr: Remove pldm_entity_association_pdr_add_from_node() 19611. pdr: Make find_entity_ref_in_tree() static 19712. pdr: Make entity_association_tree_find() static 198 199### Fixed 200 2011. requester: Fix response buffer cast in pldm_send_recv() 2022. pdr: Hoist record handle overflow test to avoid memory leak 2033. transport: Correct comparison in while loop condition 204 205## [0.4.0] - 2023-07-14 206 207### Added 208 2091. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2102. fru: Introduce get_fru_record_by_option_check() 2113. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2124. pdr: Introduce pldm_pdr_add_check() 2135. pdr: Introduce pldm_pdr_add_fru_record_set_check() 214 215### Changed 216 2171. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2182. requester: Expose pldm_close() in header 2193. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2204. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2215. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2226. pdr: pldm_pdr_init(): Return NULL on allocation failure 2237. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2248. pdr: Document preconditions for trivial accessor functions 225 226 A trivial accessor function is one that exposes properties of an object in a 227 way can't result in an error, beyond passing an invalid argument to the 228 function. For APIs meeting this definition we define a precondition that 229 struct pointers must point to valid objects to avoid polluting the function 230 prototypes. The following APIs now have this precondition explicitly defined: 231 232 - pldm_entity_extract() 233 - pldm_entity_get_parent() 234 - pldm_entity_is_exist_parent() 235 - pldm_entity_is_node_parent() 236 - pldm_is_current_parent_child 237 - pldm_is_empty_entity_assoc_tree() 238 - pldm_pdr_get_record_count() 239 - pldm_pdr_get_record_handle() 240 - pldm_pdr_get_repo_size() 241 - pldm_pdr_record_is_remote() 242 2439. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 24410. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 24511. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 24612. pdr: pldm_entity_association_tree_visit(): Document preconditions 24713. pdr: pldm_entity_association_tree_visit(): Exit early on failure 24814. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 24915. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 25016. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 25117. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 25218. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 25319. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 25420. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 25521. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 25622. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 25723. pdr: pldm_entity_get_num_children(): Don't return invalid values 25824. libpldm: Lift or remove asserts where a subsequent check exists 259 260### Deprecated 261 2621. pldm_bios_table_attr_entry_integer_encode() 263 264 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 265 2662. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 267 268 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 269 2703. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 271 272 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 273 2744. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 275 276 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 277 2785. pdr: Deprecate is_present() 279 280 There should be no users of this symbol. If you are a user, you should figure 281 out how to stop, or get in touch. This symbol will be marked static the 282 release after deprecation. 283 2846. pdr: Deprecate find_entity_ref_in_tree() 285 286 There should be no users of this symbol. If you are a user, you should figure 287 out how to stop, or get in touch. This symbol will be marked static the 288 release after deprecation. 289 2907. pdr: Deprecate entity_association_tree_find() 291 292 There should be no users of this symbol. If you are a user, you should figure 293 out how to stop, or get in touch. This symbol will be marked static the 294 release after deprecation. 295 2968. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 297 298 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 299 pldm_bios_table_append_pad_checksum() should migrate to 300 pldm_bios_table_append_pad_checksum_check() 301 3029. fru: Stabilise get_fru_record_by_option_check() 303 304 get_fru_record_by_option() is deprecated by this change. Users of 305 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 306 30710. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 308 309 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 310 Users of pldm_entity_association_pdr_add_from_node() should migrate to 311 pldm_entity_association_pdr_add_from_node_check() 312 31311. pdr: Stabilise pldm_pdr_add_check() 314 315 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 316 migrate to pldm_pdr_add_check() 317 31812. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 319 320 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 321 pldm_pdr_add_fru_record_set() should migrate to 322 pldm_pdr_add_fru_record_set_check() 323 324### Removed 325 3261. bios_table: Remove deprecated APIs sanitized by assert(): 327 328 - pldm_bios_table_string_entry_encode() 329 - pldm_bios_table_string_entry_decode_string() 330 - pldm_bios_table_attr_entry_enum_encode() 331 - pldm_bios_table_attr_entry_enum_decode_pv_num() 332 - pldm_bios_table_attr_entry_enum_decode_def_num() 333 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 334 - pldm_bios_table_attr_entry_string_encode() 335 - pldm_bios_table_attr_entry_string_decode_def_string_length() 336 337### Fixed 338 3391. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 3402. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 3413. transport: mctp-demux: Don't test socket for non-zero value 3424. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 3435. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 3446. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 3457. abi: Update to remove pldm_close() from reference dumps 3468. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 347 348## [0.3.0] - 2023-06-23 349 350### Added 351 3521. Add encode/decode pldmMessagePollEvent data 3532. README: Add a section on working with libpldm 3543. pdr: Introduce remote_container_id and associated APIs 3554. pdr: Add APIs for creating and locating remote PDRs 3565. pdr: Add pldm_pdr_find_last_in_range() 3576. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 3587. pdr: Add pldm_pdr_find_container_id_range_exclude() 359 360### Changed 361 3621. include: Move installed transport.h under libpldm/ 3632. libpldm: Explicit deprecated, stable and testing ABI classes 3643. meson: Reduce strength of oem-ibm requirements from enabled to allowed 365 366 The `oem-ibm` feature is now enabled by the default meson configuration, for 367 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 368 recipe: 369 370 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 371 372 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 373 when invoking `meson setup` 374 3754. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 3765. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 377 378### Deprecated 379 3801. bios_table: Deprecate APIs with arguments sanitized using assert() 381 382 C provides enough foot-guns without us encoding them into library APIs. 383 Specifically, deprecate the following in favour of their `*_check()` variants 384 which ensure assertions won't fail or otherwise invoke UB: 385 386 - pldm_bios_table_string_entry_encode() 387 - pldm_bios_table_string_entry_decode_string() 388 - pldm_bios_table_attr_entry_enum_encode() 389 - pldm_bios_table_attr_entry_enum_decode_pv_num() 390 - pldm_bios_table_attr_entry_enum_decode_def_num() 391 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 392 - pldm_bios_table_attr_entry_string_encode() 393 - pldm_bios_table_attr_entry_string_decode_def_string_length() 394 395### Removed 396 3971. libpldm: Remove the requester-api option 398 399### Fixed 400 4011. requester: Make pldm_open() return existing fd 4022. transport: Prevent sticking in waiting for response 4033. transport: Match on response in pldm_transport_send_recv_msg() 4044. requester: Add check before accessing hdr in pldm_recv() 4055. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 406