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: Define macros for reserved TIDs 232. pdr: Add pldm_entity_association_pdr_add_contained_entity_to_remote_pdr() 243. pdr: Add pldm_entity_association_pdr_create_new() 254. platform: Define macros for the responded transferflags 265. pdr: Add pldm_pdr_get_terminus_handle() API 276. pdr: Add related decode_entity_auxiliary_names_pdr() APIs 287. fw_update: Add encode req & decode resp for get_downstream_fw_params 29 30### Changed 31 321. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs 332. platform: Rework decode/encode_pldm_message_poll_event_data() APIs 343. platform: Stabilise decode_pldm_message_poll_event_data() APIs 35 36### Deprecated 37 381. Rename and deprecate functions with the `_check` suffix 39 40 All library function return values always need to be checked. The `_check` 41 suffix is redundant, so remove it. Migration to the non-deprecated 42 equivalents without the `_check` suffix can be performed using 43 `scripts/ apply-renames` and the [clang-rename][] configurations under 44 `evolutions/` 45 46 The deprecated functions: 47 48 - `get_fru_record_by_option_check()` 49 - `pldm_bios_table_string_entry_decode_string_check()` 50 - `pldm_bios_table_string_entry_encode_check()` 51 - `pldm_entity_association_pdr_add_check()` 52 - `pldm_entity_association_pdr_add_from_node_check()` 53 - `pldm_pdr_add_check()` 54 - `pldm_pdr_add_fru_record_set_check()` 55 56[clang-rename]: https://clang.llvm.org/extra/clang-rename.html 57 58### Removed 59 601. IBM OEM header compatibility symlinks. 61 62 Anyone left using the deprecated paths can migrate using the coccinelle patch 63 at `evolutions/current/oem-ibm-header-compat.cocci`. 64 65### Fixed 66 671. requester: instance-id: Release read lock on conflict 68 69## [0.8.0] - 2024-05-23 70 71### Added 72 731. base: Provide pldm_msg_hdr_correlate_response() 742. transport: af-mctp: Add pldm_transport_af_mctp_bind() 753. oem: ibm: Add chapdata file type support 764. base: Added PLDM_SMBIOS & PLDM_RDE message types 775. oem: meta: Add decode_oem_meta_file_io_req() 786. state-set: Add all state set values to system power state enum as per DSP0249 797. platform: Add alias members to the enum 80 pldm_pdr_repository_chg_event_change_record_event_data_operation. 81 82 enum constants with inconsistent names are deprecated with this change. 83 remove old inconsistent enum members after backward compatibility cleanup is 84 done 85 868. oem-ibm: Alias `pldm_oem_ibm_fru_field_type` members as `PLDM_OEM_IBM_*` 879. oem: ibm: Add Firmware Update Access Key(UAK) as a FRU field type 8810. platform: Add 3 PDR type enum for Redfish Device Enablement per 89 DSP0248_1.2.0 9011. state_set: Add CONNECTED and DISCONNECTED enum for Link State set 9112. entity: Add enum for Network Interface Connectors and Network Ports 92 Connection Types 9313. pdr: Add decode_numeric_effecter_pdr_data() 9414. oem: ibm: Support for the Real SAI entity id 9515. fw_update: Add encode req & decode resp for query_downstream_devices 9616. fw_update: Add encode req & decode resp for query_downstream_identifiers 9717. platform: Add support for GetStateEffecterStates command 98 99### Changed 100 1011. base: Stabilise pldm_msg_hdr_correlate_response() 1022. transport: af-mctp: Stabilise pldm_transport_af_mctp_bind() 1033. libpldm: Fix header use 1044. libpldm: More fixes for header use 1055. pdr: Stabilise pldm_pdr_find_last_in_range() API 1066. pdr: Stabilise pldm_entity_association_pdr_add_from_node_with_record_handle() 1077. oem: meta: stabilise decode_oem_meta_file_io_req() 1088. pdr: pldm_entity_association_tree_copy_root(): Document preconditions 109 110### Deprecated 111 1121. Deprecate `pldm_oem_ibm_fru_field_type` members that that are not prefixed 113 with `PLDM_OEM_IBM_` 114 115### Fixed 116 1171. libpldm: Rationalise the local and installed path of pldm.h 1182. pdr: Assign record_handle in entity_association_pdr_add_children() 1193. msgbuf: Require sensor data enum in pldm_msgbuf_extract_sensor_value() 1204. pdr: Remove redundant constant for minimum numeric sensor PDR length 1215. tests: oem: meta: Fix fileio use of msgbuf 122 123## [0.7.0] - 2023-08-29 124 125### Added 126 1271. state-set: Add new enum for Operational Fault Status enum 128 129### Changed 130 1311. transport: Match specified metadata in pldm_transport_send_recv_msg() 1322. transport: mctp-demux: Drop ABI annotation for internal symbols 1333. transport: Stabilise core transport and implementation APIs 134 135 This stabilisation covers the following headers and functions: 136 137 - libpldm/transport.h 138 139 - pldm_transport_poll() 140 - pldm_transport_send_msg() 141 - pldm_transport_recv_msg() 142 - pldm_transport_send_recv_msg() 143 144 - libpldm/transport/af-mctp.h 145 146 - pldm_transport_af_mctp_init() 147 - pldm_transport_af_mctp_destroy() 148 - pldm_transport_af_mctp_core() 149 - pldm_transport_af_mctp_init_pollfd() 150 - pldm_transport_af_mctp_map_tid() 151 - pldm_transport_af_mctp_unmap_tid() 152 153 - libpldm/transport/mctp-demux.h 154 - pldm_transport_mctp_demux_init() 155 - pldm_transport_mctp_demux_destroy() 156 - pldm_transport_mctp_demux_core() 157 - pldm_transport_mctp_demux_init_pollfd() 158 - pldm_transport_mctp_demux_map_tid() 159 - pldm_transport_mctp_demux_unmap_tid() 160 161### Deprecated 162 1631. All the existing "requester" APIs from `libpldm/pldm.h` (also known as 164 `libpldm/requester/pldm.h`): 165 166 - pldm_open() 167 - pldm_send_recv() 168 - pldm_send() 169 - pldm_recv() 170 - pldm_recv_any() 171 - pldm_close() 172 173 Users should migrate to the newer "transport" APIs instead. 174 175## Fixed 176 1771. tests: Exclude transport tests when build excludes testing ABIs 1782. abi: Capture deprecation of pldm_close() 179 180## [0.6.0] - 2023-08-22 181 182### Changed 183 1841. pdr: Avoid ID overflow in pldm_entity_association_tree_add_entity() 1852. meson: Apply `b_ndebug=if-release` by default 1863. pdr : Stabilize pldm_entity_association_tree_add_entity() 1874. pdr: Stabilise pldm_entity_association_tree_find_with_locality() 1885. pdr: Stabilize pldm_entity_node_get_remote_container_id() 1896. transport: af-mctp: Assign out-params on success in \*\_recv() 1907. transport: Generalise the pldm_transport_recv_msg() API 191 192### Removed 193 1941. pdr: Remove pldm_entity_association_pdr_add() 1952. state-set: Remove enum pldm_state_set_operational_fault_status_values 196 197### Fixed 198 1991. transport: register init_pollfd callback for af-mctp 2002. transport: fix init_pollfd function parameter 2013. transport: Fix doxygen and variables for send and recv functions 2024. transport: af-mctp: Ensure malloc() succeeds in \*\_recv() 203 204## [0.5.0] - 2023-08-09 205 206### Added 207 2081. pdr: Introduce pldm_entity_association_pdr_add_check() 209 210### Changed 211 2121. pdr: Allow record_handle to be NULL for pldm_pdr_add_check() 2132. transport: pldm_transport_poll(): Adjust return value semantics 2143. transport: free un-wanted responses in pldm_transport_send_recv_msg() 215 216### Deprecated 217 2181. state-set: Enum pldm_state_set_operational_fault_status_values 219 220 The enum operational_fault_status is defined with wrong members and will 221 eventually be replaced with the correct members. Any uses of 222 pldm_state_set_operational_fault_status_values members should move to 223 equivalent pldm_state_set_operational_stress_status_values members if needed. 224 2252. platform: Struct field name in fru_record_set PDR 226 227 References to entity_instance_num should be changed to entity_instance 228 2293. platform: Struct field name in numeric sensor value PDR 230 231 References to entity_instance_num should be changed to entity_instance 232 233### Removed 234 2351. bios_table: Remove pldm_bios_table_attr_entry_integer_encode_length() 2362. bios_table: Remove pldm_bios_table_attr_value_entry_encode_enum() 2373. bios_table: Remove pldm_bios_table_attr_value_entry_encode_string() 2384. bios_table: Remove pldm_bios_table_attr_value_entry_encode_integer() 2395. bios_table: Remove pldm_bios_table_append_pad_checksum() 2406. fru: Remove get_fru_record_by_option() 2417. pdr: Make is_present() static 2428. pdr: Remove pldm_pdr_add() 2439. pdr: Remove pldm_pdr_add_fru_record_set() 24410. pdr: Remove pldm_entity_association_pdr_add_from_node() 24511. pdr: Make find_entity_ref_in_tree() static 24612. pdr: Make entity_association_tree_find() static 247 248### Fixed 249 2501. requester: Fix response buffer cast in pldm_send_recv() 2512. pdr: Hoist record handle overflow test to avoid memory leak 2523. transport: Correct comparison in while loop condition 253 254## [0.4.0] - 2023-07-14 255 256### Added 257 2581. bios_table: Introduce pldm_bios_table_append_pad_checksum_check() 2592. fru: Introduce get_fru_record_by_option_check() 2603. pdr: Introduce pldm_entity_association_pdr_add_from_node_check() 2614. pdr: Introduce pldm_pdr_add_check() 2625. pdr: Introduce pldm_pdr_add_fru_record_set_check() 263 264### Changed 265 2661. requester: Mark pldm_close() as LIBPLDM_ABI_TESTING 2672. requester: Expose pldm_close() in header 2683. bios_table: pldm_bios_table_string_entry_encode_check(): Handle overflow 2694. bios_table: pldm_bios_table_iter_create(): Return NULL on failed alloc 2705. bios_table: pldm_bios_table_iter_next(): Invalid entry halts iteration 2716. pdr: pldm_pdr_init(): Return NULL on allocation failure 2727. pdr: pldm_pdr_destroy(): Exit early if repo is NULL 2738. pdr: Document preconditions for trivial accessor functions 274 275 A trivial accessor function is one that exposes properties of an object in a 276 way can't result in an error, beyond passing an invalid argument to the 277 function. For APIs meeting this definition we define a precondition that 278 struct pointers must point to valid objects to avoid polluting the function 279 prototypes. The following APIs now have this precondition explicitly defined: 280 281 - pldm_entity_extract() 282 - pldm_entity_get_parent() 283 - pldm_entity_is_exist_parent() 284 - pldm_entity_is_node_parent() 285 - pldm_is_current_parent_child 286 - pldm_is_empty_entity_assoc_tree() 287 - pldm_pdr_get_record_count() 288 - pldm_pdr_get_record_handle() 289 - pldm_pdr_get_repo_size() 290 - pldm_pdr_record_is_remote() 291 2929. pdr: pldm_entity_node_get_remote_container_id() is a trivial accessor 29310. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Exit early on NULL arguments 29411. pdr: pldm_entity_association_tree_init(): Return NULL on failed alloc 29512. pdr: pldm_entity_association_tree_visit(): Document preconditions 29613. pdr: pldm_entity_association_tree_visit(): Exit early on failure 29714. pdr: pldm_entity_association_tree_destroy(): Exit early on bad argument 29815. pdr: pldm_entity_get_num_children(): Return zero for invalid arguments 29916. pdr: pldm_is_current_parent_child(): Return false for invalid arguments 30017. pdr: pldm_entity_association_pdr_add(): Exit early on bad arguments 30118. pdr: pldm_find_entity_ref_in_tree(): Exit early on bad arguments 30219. pdr: pldm_entity_association_tree_find(): Early exit on bad arguments 30320. pdr: pldm_entity_association_tree_destroy_root(): Exit early on bad arg 30421. pdr: pldm_entity_association_pdr_extract(): Early exit on bad arguments 30522. pdr: pldm_entity_association_pdr_extract(): Assign out params at exit 30623. pdr: pldm_entity_get_num_children(): Don't return invalid values 30724. libpldm: Lift or remove asserts where a subsequent check exists 308 309### Deprecated 310 3111. pldm_bios_table_attr_entry_integer_encode() 312 313 Migrate to pldm_bios_table_attr_entry_integer_encode_check() 314 3152. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_enum() 316 317 Migrate to pldm_bios_table_attr_value_entry_encode_enum_check() 318 3193. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_string() 320 321 Migrate to pldm_bios_table_attr_value_entry_encode_string_check() 322 3234. bios_table: Deprecate pldm_bios_table_attr_value_entry_encode_integer() 324 325 Migrate to pldm_bios_table_attr_value_entry_encode_integer_check() 326 3275. pdr: Deprecate is_present() 328 329 There should be no users of this symbol. If you are a user, you should figure 330 out how to stop, or get in touch. This symbol will be marked static the 331 release after deprecation. 332 3336. pdr: Deprecate find_entity_ref_in_tree() 334 335 There should be no users of this symbol. If you are a user, you should figure 336 out how to stop, or get in touch. This symbol will be marked static the 337 release after deprecation. 338 3397. pdr: Deprecate entity_association_tree_find() 340 341 There should be no users of this symbol. If you are a user, you should figure 342 out how to stop, or get in touch. This symbol will be marked static the 343 release after deprecation. 344 3458. bios_table: Stabilise pldm_bios_table_append_pad_checksum_check() 346 347 pldm_bios_table_append_pad_checksum() is deprecated by this change. Users of 348 pldm_bios_table_append_pad_checksum() should migrate to 349 pldm_bios_table_append_pad_checksum_check() 350 3519. fru: Stabilise get_fru_record_by_option_check() 352 353 get_fru_record_by_option() is deprecated by this change. Users of 354 get_fru_record_by_option() should migrate to get_fru_record_by_option_check() 355 35610. pdr: Stabilise pldm_entity_association_pdr_add_from_node_check() 357 358 pldm_entity_association_pdr_add_from_node() is deprecated by this change. 359 Users of pldm_entity_association_pdr_add_from_node() should migrate to 360 pldm_entity_association_pdr_add_from_node_check() 361 36211. pdr: Stabilise pldm_pdr_add_check() 363 364 pldm_pdr_add() is deprecated by this change. Users of pldm_pdr_add() should 365 migrate to pldm_pdr_add_check() 366 36712. pdr: Stabilise pldm_pdr_add_fru_record_set_check() 368 369 pldm_pdr_add_fru_record_set() is deprecated by this change. Users of 370 pldm_pdr_add_fru_record_set() should migrate to 371 pldm_pdr_add_fru_record_set_check() 372 373### Removed 374 3751. bios_table: Remove deprecated APIs sanitized by assert(): 376 377 - pldm_bios_table_string_entry_encode() 378 - pldm_bios_table_string_entry_decode_string() 379 - pldm_bios_table_attr_entry_enum_encode() 380 - pldm_bios_table_attr_entry_enum_decode_pv_num() 381 - pldm_bios_table_attr_entry_enum_decode_def_num() 382 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 383 - pldm_bios_table_attr_entry_string_encode() 384 - pldm_bios_table_attr_entry_string_decode_def_string_length() 385 386### Fixed 387 3881. pdr: Return success for pldm_pdr_find_child_container_id_range_exclude() API 3892. pdr: Rework pldm_pdr_find_container_id_range_exclude() API 3903. transport: mctp-demux: Don't test socket for non-zero value 3914. requester: Return PLDM_REQUESTER_OPEN_FAIL from pldm_open() on error 3925. pdr: pldm_pdr_fru_record_set_find_by_rsi(): Document reality of return 3936. transport: Fix possible NULL ptr deref in pldm_socket_sndbuf_init() 3947. abi: Update to remove pldm_close() from reference dumps 3958. bios_table: Annotate pldm_bios_table_attr_value_entry_encode_integer() 396 397## [0.3.0] - 2023-06-23 398 399### Added 400 4011. Add encode/decode pldmMessagePollEvent data 4022. README: Add a section on working with libpldm 4033. pdr: Introduce remote_container_id and associated APIs 4044. pdr: Add APIs for creating and locating remote PDRs 4055. pdr: Add pldm_pdr_find_last_in_range() 4066. pdr: Add pldm_entity_association_pdr_add_from_node_with_record_handle() 4077. pdr: Add pldm_pdr_find_container_id_range_exclude() 408 409### Changed 410 4111. include: Move installed transport.h under libpldm/ 4122. libpldm: Explicit deprecated, stable and testing ABI classes 4133. meson: Reduce strength of oem-ibm requirements from enabled to allowed 414 415 The `oem-ibm` feature is now enabled by the default meson configuration, for 416 CI purposes. `oem-ibm` is still disabled by default in the `libpldm` bitbake 417 recipe: 418 419 <https://github.com/openbmc/openbmc/blob/master/meta-phosphor/recipes-phosphor/libpldm/libpldm_git.bb#L10> 420 421 To disable `oem-ibm` in your development builds, pass `-Doem-ibm=disabled` 422 when invoking `meson setup` 423 4244. bios_table: Relax pldm_bios_table_string_entry_decode_string_check() 4255. bios_table: Relax pldm_bios_table_attr_entry_enum_decode_pv_hdls_check() 426 427### Deprecated 428 4291. bios_table: Deprecate APIs with arguments sanitized using assert() 430 431 C provides enough foot-guns without us encoding them into library APIs. 432 Specifically, deprecate the following in favour of their `*_check()` variants 433 which ensure assertions won't fail or otherwise invoke UB: 434 435 - pldm_bios_table_string_entry_encode() 436 - pldm_bios_table_string_entry_decode_string() 437 - pldm_bios_table_attr_entry_enum_encode() 438 - pldm_bios_table_attr_entry_enum_decode_pv_num() 439 - pldm_bios_table_attr_entry_enum_decode_def_num() 440 - pldm_bios_table_attr_entry_enum_decode_pv_hdls() 441 - pldm_bios_table_attr_entry_string_encode() 442 - pldm_bios_table_attr_entry_string_decode_def_string_length() 443 444### Removed 445 4461. libpldm: Remove the requester-api option 447 448### Fixed 449 4501. requester: Make pldm_open() return existing fd 4512. transport: Prevent sticking in waiting for response 4523. transport: Match on response in pldm_transport_send_recv_msg() 4534. requester: Add check before accessing hdr in pldm_recv() 4545. bios_table: pldm_bios_table_attr_entry_string_info_check() NULL deref 455