commit 7c655302fb78574a89725a860d34c8e8cfadb1ca
author Chau Ly <chaul@amperecomputing.com> Wed Aug 13 05:16:52 2025 +0000
committer Andrew Jeffery <andrew@codeconstruct.com.au> Fri Aug 15 01:11:24 2025 +0000
tree a4bbc87cf6b20d5d97c7c7c1bd6f2606bacdc322
parent 41846238620bb1d650da49566a7347c676726c39

platform: Reinforce some symbol names

This commit rename some symbol names for base APIs to reinforce API
naming convention defined here [1]. The list of change includes:

1. `struct pldm_file_descriptor_pdr` to
    `struct pldm_platform_file_descriptor_pdr`
2. `decode_pldm_file_descriptor_pdr()` to
    `decode_pldm_platform_file_descriptor_pdr()`

[1]: https://github.com/openbmc/libpldm/blob/main/docs/checklists/changes.md#adding-a-new-api

Change-Id: I76bd12fa59a7d61d450d9d36cbf091b39101faa8
Signed-off-by: Chau Ly <chaul@amperecomputing.com>

CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6eb21d6..d46a9fa 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -34,6 +34,12 @@
   - Remove `__attribute__((packed))` from
     `struct pldm_base_multipart_receive_req`
 
+- platform: Rename symbols:
+  - `struct pldm_file_descriptor_pdr` to
+    `struct pldm_platform_file_descriptor_pdr`
+  - `decode_pldm_file_descriptor_pdr()` to
+    `decode_pldm_platform_file_descriptor_pdr()`
+
 ### Deprecated
 
 ### Removed

include/libpldm/platform.h

diff --git a/include/libpldm/platform.h b/include/libpldm/platform.h
index cc696a4..ff66853 100644
--- a/include/libpldm/platform.h
+++ b/include/libpldm/platform.h
@@ -950,13 +950,13 @@
 	uint8_t effecter_names[1];
 } __attribute__((packed));
 
-/** @struct pldm_file_descriptor_pdr
+/** @struct pldm_platform_file_descriptor_pdr
  *
  *  Structure representing PLDM File Descriptor PDR for unpacked value
  *  Refer to: DSP0248_1.3.0: 28.30 Table 108
  */
 
-struct pldm_file_descriptor_pdr {
+struct pldm_platform_file_descriptor_pdr {
 	struct pldm_value_pdr_hdr hdr;
 	uint16_t terminus_handle;
 	uint16_t file_identifier;
@@ -2719,8 +2719,9 @@
  *          -EOVERFLOW if the original length of the data buffer is smaller
  *          than the target extract length
  */
-int decode_pldm_file_descriptor_pdr(const void *data, size_t data_length,
-				    struct pldm_file_descriptor_pdr *pdr);
+int decode_pldm_platform_file_descriptor_pdr(
+	const void *data, size_t data_length,
+	struct pldm_platform_file_descriptor_pdr *pdr);
 
 /** @brief Decode SetNumericSensorEnable request
  *

src/dsp/platform.c

diff --git a/src/dsp/platform.c b/src/dsp/platform.c
index 297a033..9af2d67 100644
--- a/src/dsp/platform.c
+++ b/src/dsp/platform.c
@@ -3473,8 +3473,9 @@
 }
 
 LIBPLDM_ABI_TESTING
-int decode_pldm_file_descriptor_pdr(const void *data, size_t data_length,
-				    struct pldm_file_descriptor_pdr *pdr)
+int decode_pldm_platform_file_descriptor_pdr(
+	const void *data, size_t data_length,
+	struct pldm_platform_file_descriptor_pdr *pdr)
 {
 	PLDM_MSGBUF_DEFINE_P(buf);
 	int rc;

tests/dsp/platform.cpp

diff --git a/tests/dsp/platform.cpp b/tests/dsp/platform.cpp
index 4427cbc..6f4c517 100644
--- a/tests/dsp/platform.cpp
+++ b/tests/dsp/platform.cpp
@@ -6188,10 +6188,10 @@
     const char expectFileName[] = "File1";
     const char expectOEMClassificationName[] = "OEM File";
 
-    struct pldm_file_descriptor_pdr decodedPdr = {};
+    struct pldm_platform_file_descriptor_pdr decodedPdr = {};
 
-    auto rc =
-        decode_pldm_file_descriptor_pdr(pdr1.data(), pdr1.size(), &decodedPdr);
+    auto rc = decode_pldm_platform_file_descriptor_pdr(pdr1.data(), pdr1.size(),
+                                                       &decodedPdr);
 
     ASSERT_EQ(0, rc);
     EXPECT_EQ(1, decodedPdr.terminus_handle);
@@ -6258,12 +6258,14 @@
         0x00, // File Name = "File1\NULL"
     };
 
-    struct pldm_file_descriptor_pdr decodedPdr = {};
+    struct pldm_platform_file_descriptor_pdr decodedPdr = {};
 
-    rc = decode_pldm_file_descriptor_pdr(nullptr, pdr1.size(), &decodedPdr);
+    rc = decode_pldm_platform_file_descriptor_pdr(nullptr, pdr1.size(),
+                                                  &decodedPdr);
     EXPECT_EQ(-EINVAL, rc);
 
-    rc = decode_pldm_file_descriptor_pdr(pdr1.data(), pdr1.size(), nullptr);
+    rc = decode_pldm_platform_file_descriptor_pdr(pdr1.data(), pdr1.size(),
+                                                  nullptr);
     EXPECT_EQ(-EINVAL, rc);
 }
 #endif
@@ -6299,10 +6301,10 @@
         0x00, // File Name = "File1\NULL"
     };
 
-    struct pldm_file_descriptor_pdr decodedPdr = {};
+    struct pldm_platform_file_descriptor_pdr decodedPdr = {};
 
     /* Expect error: Invalid input data length*/
-    rc = decode_pldm_file_descriptor_pdr(pdr1.data(), 1, &decodedPdr);
+    rc = decode_pldm_platform_file_descriptor_pdr(pdr1.data(), 1, &decodedPdr);
     EXPECT_EQ(-EOVERFLOW, rc);
 }
 #endif
@@ -6339,13 +6341,14 @@
         0x00, // File Name = "File1\NULL"
     };
 
-    struct pldm_file_descriptor_pdr decodedPdr = {};
+    struct pldm_platform_file_descriptor_pdr decodedPdr = {};
 
     /*
      * Expect error: The original length of the data buffer is larger than
      * the target extract length.
      */
-    rc = decode_pldm_file_descriptor_pdr(pdr1.data(), pdr1.size(), &decodedPdr);
+    rc = decode_pldm_platform_file_descriptor_pdr(pdr1.data(), pdr1.size(),
+                                                  &decodedPdr);
     EXPECT_EQ(-EBADMSG, rc);
 }
 
@@ -6383,13 +6386,14 @@
         0x00 // OEM File Classification Name = "OEM File\NULL"
     };
 
-    struct pldm_file_descriptor_pdr decodedPdr = {};
+    struct pldm_platform_file_descriptor_pdr decodedPdr = {};
 
     /*
      * Expect error: The original length of the data buffer is smaller than
      * the target extract length.
      */
-    rc = decode_pldm_file_descriptor_pdr(pdr1.data(), pdr1.size(), &decodedPdr);
+    rc = decode_pldm_platform_file_descriptor_pdr(pdr1.data(), pdr1.size(),
+                                                  &decodedPdr);
     EXPECT_EQ(-EOVERFLOW, rc);
 }
 #endif