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. base: Provide pldm_msg_hdr_correlate_response() 232. transport: af-mctp: Add pldm_transport_af_mctp_bind() 243. oem: ibm: Add chapdata file type support 254. base: Added PLDM_SMBIOS & PLDM_RDE message types 265. oem: meta: Add decode_oem_meta_file_io_req() 276. state-set: Add all state set values to system power state enum as per DSP0249 287. platform: Add alias members to the enum 29 pldm_pdr_repository_chg_event_change_record_event_data_operation. 30 31 enum constants with inconsistent names are deprecated with this change. 32 remove old inconsistent enum members after backward compatibility cleanup is 33 done 34 358. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 369. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 3710. platform: Add 3 PDR type enum for Redfish Device Enablement per 38 DSP0248_1.2.0 3911. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 4012. entity: Add enum for Network Interface Connectors and Network Ports 41 Connection Types 4213. pdr: Add decode_numeric_effecter_pdr_data() 4314. oem: ibm: Support for the Real SAI entity id 4415. fw_update: Add encode req & decode resp for query_downstream_devices 4516. fw_update: Add encode req & decode resp for query_downstream_identifiers 46 47### Changed 48 491. base: Stabilise pldm_msg_hdr_correlate_response() 502. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 513. libpldm: Fix header use 524. libpldm: More fixes for header use 535. pdr: Stabilise pldm_pdr_find_last_in_range() API 546. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 557. oem: meta: stabilise decode_oem_meta_file_io_req() 568. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 57 58### Deprecated 59 601. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 61 with `PLDM_OEM_IBM_` 62 63### Fixed 64 651. libpldm: Rationalise the local and installed path of pldm.h 662. pdr: Assign record_handle in entity_association_pdr_add_children() 673. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 684. pdr: Remove redundant constant for minimum numeric sensor PDR length 69 70## [0.7.0] - 2023-08-29 71 72### Added 73 741. state-set: Add new enum for Operational Fault Status enum 75 76### Changed 77 781. transport: Match specified metadata in pldm_transport_send_recv_msg() 792. transport: mctp-demux: Drop ABI annotation for internal symbols 803. transport: Stabilise core transport and implementation APIs 81 82 This stabilisation covers the following headers and functions: 83 84 - libpldm/transport.h 85 86 - pldm_transport_poll() 87 - pldm_transport_send_msg() 88 - pldm_transport_recv_msg() 89 - pldm_transport_send_recv_msg() 90 91 - libpldm/transport/af-mctp.h 92 93 - pldm_transport_af_mctp_init() 94 - pldm_transport_af_mctp_destroy() 95 - pldm_transport_af_mctp_core() 96 - pldm_transport_af_mctp_init_pollfd() 97 - pldm_transport_af_mctp_map_tid() 98 - pldm_transport_af_mctp_unmap_tid() 99 100 - libpldm/transport/mctp-demux.h 101 - pldm_transport_mctp_demux_init() 102 - pldm_transport_mctp_demux_destroy() 103 - pldm_transport_mctp_demux_core() 104 - pldm_transport_mctp_demux_init_pollfd() 105 - pldm_transport_mctp_demux_map_tid() 106 - pldm_transport_mctp_demux_unmap_tid() 107 108### Deprecated 109 1101. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 111 `libpldm/requester/pldm.h`): 112 113 - pldm_open() 114 - pldm_send_recv() 115 - pldm_send() 116 - pldm_recv() 117 - pldm_recv_any() 118 - pldm_close() 119 120 Users should migrate to the newer "transport" APIs instead. 121 122## Fixed 123 1241. tests: Exclude transport tests when build excludes testing ABIs 1252. abi: Capture deprecation of pldm_close() 126 127## [0.6.0] - 2023-08-22 128 129### Changed 130 1311. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1322. meson: Apply `b_ndebug=if-release` by default 1333. pdr : Stabilize pldm_entity_association_tree_add_entity() 1344. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 1355. pdr: Stabilize pldm_entity_node_get_remote_container_id() 1366. transport: af-mctp: Assign out-params on success in \*\_recv() 1377. transport: Generalise the pldm_transport_recv_msg() API 138 139### Removed 140 1411. pdr: Remove pldm_entity_association_pdr_add() 1422. state-set: Remove enum pldm_state_set_operational_fault_status_values 143 144### Fixed 145 1461. transport: register init_pollfd callback for af-mctp 1472. transport: fix init_pollfd function parameter 1483. transport: Fix doxygen and variables for send and recv functions 1494. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 150 151## [0.5.0] - 2023-08-09 152 153### Added 154 1551. pdr: Introduce pldm_entity_association_pdr_add_check() 156 157### Changed 158 1591. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 1602. transport: pldm_transport_poll(): Adjust return value semantics 1613. transport: free un-wanted responses in pldm_transport_send_recv_msg() 162 163### Deprecated 164 1651. state-set: Enum pldm_state_set_operational_fault_status_values 166 167 The enum operational_fault_status is defined with wrong members and will 168 eventually be replaced with the correct members. Any uses of 169 pldm_state_set_operational_fault_status_values members should move to 170 equivalent pldm_state_set_operational_stress_status_values members if needed. 171 1722. platform: Struct field name in fru_record_set PDR 173 174 References to entity_instance_num should be changed to entity_instance 175 1763. platform: Struct field name in numeric sensor value PDR 177 178 References to entity_instance_num should be changed to entity_instance 179 180### Removed 181 1821. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 1832. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 1843. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 1854. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 1865. bios_table: Remove pldm_bios_table_append_pad_checksum() 1876. fru: Remove get_fru_record_by_option() 1887. pdr: Make is_present() static 1898. pdr: Remove pldm_pdr_add() 1909. pdr: Remove pldm_pdr_add_fru_record_set() 19110. pdr: Remove pldm_entity_association_pdr_add_from_node() 19211. pdr: Make find_entity_ref_in_tree() static 19312. pdr: Make entity_association_tree_find() static 194 195### Fixed 196 1971. requester: Fix response buffer cast in pldm_send_recv() 1982. pdr: Hoist record handle overflow test to avoid memory leak 1993. transport: Correct comparison in while loop condition 200 201## [0.4.0] - 2023-07-14 202 203### Added 204 2051. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2062. fru: Introduce get_fru_record_by_option_check() 2073. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2084. pdr: Introduce pldm_pdr_add_check() 2095. pdr: Introduce pldm_pdr_add_fru_record_set_check() 210 211### Changed 212 2131. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2142. requester: Expose pldm_close() in header 2153. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2164. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2175. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2186. pdr: pldm_pdr_init(): Return NULL on allocation failure 2197. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2208. pdr: Document preconditions for trivial accessor functions 221 222 A trivial accessor function is one that exposes properties of an object in a 223 way can't result in an error, beyond passing an invalid argument to the 224 function. For APIs meeting this definition we define a precondition that 225 struct pointers must point to valid objects to avoid polluting the function 226 prototypes. The following APIs now have this precondition explicitly defined: 227 228 - pldm_entity_extract() 229 - pldm_entity_get_parent() 230 - pldm_entity_is_exist_parent() 231 - pldm_entity_is_node_parent() 232 - pldm_is_current_parent_child 233 - pldm_is_empty_entity_assoc_tree() 234 - pldm_pdr_get_record_count() 235 - pldm_pdr_get_record_handle() 236 - pldm_pdr_get_repo_size() 237 - pldm_pdr_record_is_remote() 238 2399. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 24010. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 24111. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 24212. pdr: pldm_entity_association_tree_visit(): Document preconditions 24313. pdr: pldm_entity_association_tree_visit(): Exit early on failure 24414. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 24515. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 24616. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 24717. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 24818. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 24919. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 25020. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 25121. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 25222. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 25323. pdr: pldm_entity_get_num_children(): Don't return invalid values 25424. libpldm: Lift or remove asserts where a subsequent check exists 255 256### Deprecated 257 2581. pldm_bios_table_attr_entry_integer_encode() 259 260 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 261 2622. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 263 264 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 265 2663. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 267 268 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 269 2704. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 271 272 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 273 2745. pdr: Deprecate is_present() 275 276 There should be no users of this symbol. If you are a user, you should figure 277 out how to stop, or get in touch. This symbol will be marked static the 278 release after deprecation. 279 2806. pdr: Deprecate find_entity_ref_in_tree() 281 282 There should be no users of this symbol. If you are a user, you should figure 283 out how to stop, or get in touch. This symbol will be marked static the 284 release after deprecation. 285 2867. pdr: Deprecate entity_association_tree_find() 287 288 There should be no users of this symbol. If you are a user, you should figure 289 out how to stop, or get in touch. This symbol will be marked static the 290 release after deprecation. 291 2928. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 293 294 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 295 pldm_bios_table_append_pad_checksum() should migrate to 296 pldm_bios_table_append_pad_checksum_check() 297 2989. fru: Stabilise get_fru_record_by_option_check() 299 300 get_fru_record_by_option() is deprecated by this change. Users of 301 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 302 30310. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 304 305 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 306 Users of pldm_entity_association_pdr_add_from_node() should migrate to 307 pldm_entity_association_pdr_add_from_node_check() 308 30911. pdr: Stabilise pldm_pdr_add_check() 310 311 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 312 migrate to pldm_pdr_add_check() 313 31412. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 315 316 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 317 pldm_pdr_add_fru_record_set() should migrate to 318 pldm_pdr_add_fru_record_set_check() 319 320### Removed 321 3221. bios_table: Remove deprecated APIs sanitized by assert(): 323 324 - pldm_bios_table_string_entry_encode() 325 - pldm_bios_table_string_entry_decode_string() 326 - pldm_bios_table_attr_entry_enum_encode() 327 - pldm_bios_table_attr_entry_enum_decode_pv_num() 328 - pldm_bios_table_attr_entry_enum_decode_def_num() 329 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 330 - pldm_bios_table_attr_entry_string_encode() 331 - pldm_bios_table_attr_entry_string_decode_def_string_length() 332 333### Fixed 334 3351. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 3362. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 3373. transport: mctp-demux: Don't test socket for non-zero value 3384. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 3395. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 3406. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 3417. abi: Update to remove pldm_close() from reference dumps 3428. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 343 344## [0.3.0] - 2023-06-23 345 346### Added 347 3481. Add encode/decode pldmMessagePollEvent data 3492. README: Add a section on working with libpldm 3503. pdr: Introduce remote_container_id and associated APIs 3514. pdr: Add APIs for creating and locating remote PDRs 3525. pdr: Add pldm_pdr_find_last_in_range() 3536. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 3547. pdr: Add pldm_pdr_find_container_id_range_exclude() 355 356### Changed 357 3581. include: Move installed transport.h under libpldm/ 3592. libpldm: Explicit deprecated, stable and testing ABI classes 3603. meson: Reduce strength of oem-ibm requirements from enabled to allowed 361 362 The `oem-ibm` feature is now enabled by the default meson configuration, for 363 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 364 recipe: 365 366 https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10 367 368 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 369 when invoking `meson setup` 370 3714. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 3725. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 373 374### Deprecated 375 3761. bios_table: Deprecate APIs with arguments sanitized using assert() 377 378 C provides enough foot-guns without us encoding them into library APIs. 379 Specifically, deprecate the following in favour of their `*_check()` variants 380 which ensure assertions won't fail or otherwise invoke UB: 381 382 - pldm_bios_table_string_entry_encode() 383 - pldm_bios_table_string_entry_decode_string() 384 - pldm_bios_table_attr_entry_enum_encode() 385 - pldm_bios_table_attr_entry_enum_decode_pv_num() 386 - pldm_bios_table_attr_entry_enum_decode_def_num() 387 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 388 - pldm_bios_table_attr_entry_string_encode() 389 - pldm_bios_table_attr_entry_string_decode_def_string_length() 390 391### Removed 392 3931. libpldm: Remove the requester-api option 394 395### Fixed 396 3971. requester: Make pldm_open() return existing fd 3982. transport: Prevent sticking in waiting for response 3993. transport: Match on response in pldm_transport_send_recv_msg() 4004. requester: Add check before accessing hdr in pldm_recv() 4015. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 402