dsp: bios_table: Rename pldm_bios_table_string_entry_decode_string_check()
Introduce pldm_bios_table_string_entry_decode_string(), deprecate
pldm_bios_table_string_entry_decode_string_check(), add the rename
configuration and apply it.
gitlint-ignore: T1
Change-Id: Ia204acd95d9e1d9bc80d91dd0ff6ffea3a1fe243
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6b9703b..da6a30a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -46,6 +46,7 @@
The deprecated functions:
- `get_fru_record_by_option_check()`
+ - `pldm_bios_table_string_entry_decode_string_check()`
- `pldm_bios_table_string_entry_encode_check()`
- `pldm_entity_association_pdr_add_check()`
- `pldm_entity_association_pdr_add_from_node_check()`
diff --git a/abi/x86_64/gcc.dump b/abi/x86_64/gcc.dump
index d831adb..3da6907 100644
--- a/abi/x86_64/gcc.dump
+++ b/abi/x86_64/gcc.dump
@@ -1598,7 +1598,7 @@
},
'17275' => {
'Header' => 'bios_table.h',
- 'Line' => '635',
+ 'Line' => '638',
'Param' => {
'0' => {
'name' => 'table',
@@ -1618,7 +1618,7 @@
},
'17420' => {
'Header' => 'bios_table.h',
- 'Line' => '626',
+ 'Line' => '629',
'Param' => {
'0' => {
'name' => 'src_table',
@@ -1654,7 +1654,7 @@
},
'18108' => {
'Header' => 'bios_table.h',
- 'Line' => '592',
+ 'Line' => '595',
'Param' => {
'0' => {
'name' => 'table',
@@ -1677,7 +1677,7 @@
},
'18371' => {
'Header' => 'bios_table.h',
- 'Line' => '199',
+ 'Line' => '202',
'Param' => {
'0' => {
'name' => 'table',
@@ -1700,7 +1700,7 @@
},
'18638' => {
'Header' => 'bios_table.h',
- 'Line' => '189',
+ 'Line' => '192',
'Param' => {
'0' => {
'name' => 'table',
@@ -1723,7 +1723,7 @@
},
'18900' => {
'Header' => 'bios_table.h',
- 'Line' => '148',
+ 'Line' => '151',
'Param' => {
'0' => {
'name' => 'table',
@@ -1748,7 +1748,7 @@
},
'19290' => {
'Header' => 'bios_table.h',
- 'Line' => '157',
+ 'Line' => '160',
'Param' => {
'0' => {
'name' => 'table',
@@ -1847,7 +1847,7 @@
},
'20599' => {
'Header' => 'bios_table.h',
- 'Line' => '611',
+ 'Line' => '614',
'Param' => {
'0' => {
'name' => 'table',
@@ -1872,7 +1872,7 @@
},
'20899' => {
'Header' => 'bios_table.h',
- 'Line' => '599',
+ 'Line' => '602',
'Param' => {
'0' => {
'name' => 'size_without_pad',
@@ -1884,7 +1884,7 @@
},
'21254' => {
'Header' => 'bios_table.h',
- 'Line' => '574',
+ 'Line' => '577',
'Param' => {
'0' => {
'name' => 'entry',
@@ -1899,7 +1899,7 @@
},
'21303' => {
'Header' => 'bios_table.h',
- 'Line' => '581',
+ 'Line' => '584',
'Param' => {
'0' => {
'name' => 'entry',
@@ -1911,7 +1911,7 @@
},
'21787' => {
'Header' => 'bios_table.h',
- 'Line' => '548',
+ 'Line' => '551',
'Param' => {
'0' => {
'name' => 'entry',
@@ -1926,7 +1926,7 @@
},
'21927' => {
'Header' => 'bios_table.h',
- 'Line' => '564',
+ 'Line' => '567',
'Param' => {
'0' => {
'name' => 'entry',
@@ -1961,13 +1961,13 @@
},
'22196' => {
'Header' => 'bios_table.h',
- 'Line' => '542',
+ 'Line' => '545',
'Return' => '1145',
'ShortName' => 'pldm_bios_table_attr_value_entry_encode_integer_length'
},
'22358' => {
'Header' => 'bios_table.h',
- 'Line' => '535',
+ 'Line' => '538',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2007,7 +2007,7 @@
},
'22758' => {
'Header' => 'bios_table.h',
- 'Line' => '516',
+ 'Line' => '519',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2023,7 +2023,7 @@
},
'22853' => {
'Header' => 'bios_table.h',
- 'Line' => '506',
+ 'Line' => '509',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2038,7 +2038,7 @@
},
'22994' => {
'Header' => 'bios_table.h',
- 'Line' => '500',
+ 'Line' => '503',
'Param' => {
'0' => {
'name' => 'string_length',
@@ -2053,7 +2053,7 @@
},
'23176' => {
'Header' => 'bios_table.h',
- 'Line' => '490',
+ 'Line' => '493',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2090,7 +2090,7 @@
},
'23495' => {
'Header' => 'bios_table.h',
- 'Line' => '471',
+ 'Line' => '474',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2110,7 +2110,7 @@
},
'23742' => {
'Header' => 'bios_table.h',
- 'Line' => '461',
+ 'Line' => '464',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2125,7 +2125,7 @@
},
'23791' => {
'Header' => 'bios_table.h',
- 'Line' => '455',
+ 'Line' => '458',
'Param' => {
'0' => {
'name' => 'count',
@@ -2140,7 +2140,7 @@
},
'23840' => {
'Header' => 'bios_table.h',
- 'Line' => '448',
+ 'Line' => '451',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2155,7 +2155,7 @@
},
'23889' => {
'Header' => 'bios_table.h',
- 'Line' => '441',
+ 'Line' => '444',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2170,7 +2170,7 @@
},
'24436' => {
'Header' => 'bios_table.h',
- 'Line' => '433',
+ 'Line' => '436',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2205,7 +2205,7 @@
},
'24572' => {
'Header' => 'bios_table.h',
- 'Line' => '421',
+ 'Line' => '424',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2230,7 +2230,7 @@
},
'24844' => {
'Header' => 'bios_table.h',
- 'Line' => '402',
+ 'Line' => '405',
'Param' => {
'0' => {
'name' => 'info',
@@ -2246,13 +2246,13 @@
},
'25148' => {
'Header' => 'bios_table.h',
- 'Line' => '409',
+ 'Line' => '412',
'Return' => '1145',
'ShortName' => 'pldm_bios_table_attr_entry_integer_encode_length'
},
'25310' => {
'Header' => 'bios_table.h',
- 'Line' => '376',
+ 'Line' => '379',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2272,7 +2272,7 @@
},
'25579' => {
'Header' => 'bios_table.h',
- 'Line' => '368',
+ 'Line' => '371',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2287,7 +2287,7 @@
},
'25648' => {
'Header' => 'bios_table.h',
- 'Line' => '360',
+ 'Line' => '363',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2302,7 +2302,7 @@
},
'25717' => {
'Header' => 'bios_table.h',
- 'Line' => '352',
+ 'Line' => '355',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2317,7 +2317,7 @@
},
'25786' => {
'Header' => 'bios_table.h',
- 'Line' => '344',
+ 'Line' => '347',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2337,7 +2337,7 @@
},
'25956' => {
'Header' => 'bios_table.h',
- 'Line' => '333',
+ 'Line' => '336',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2361,7 +2361,7 @@
},
'26320' => {
'Header' => 'bios_table.h',
- 'Line' => '312',
+ 'Line' => '315',
'Param' => {
'0' => {
'name' => 'info',
@@ -2380,7 +2380,7 @@
},
'26589' => {
'Header' => 'bios_table.h',
- 'Line' => '320',
+ 'Line' => '323',
'Param' => {
'0' => {
'name' => 'def_str_len',
@@ -2395,7 +2395,7 @@
},
'26821' => {
'Header' => 'bios_table.h',
- 'Line' => '286',
+ 'Line' => '289',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2415,7 +2415,7 @@
},
'27100' => {
'Header' => 'bios_table.h',
- 'Line' => '274',
+ 'Line' => '277',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2440,7 +2440,7 @@
},
'27265' => {
'Header' => 'bios_table.h',
- 'Line' => '257',
+ 'Line' => '260',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2460,7 +2460,7 @@
},
'27427' => {
'Header' => 'bios_table.h',
- 'Line' => '247',
+ 'Line' => '250',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2480,7 +2480,7 @@
},
'27487' => {
'Header' => 'bios_table.h',
- 'Line' => '236',
+ 'Line' => '239',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2504,7 +2504,7 @@
},
'27821' => {
'Header' => 'bios_table.h',
- 'Line' => '222',
+ 'Line' => '225',
'Param' => {
'0' => {
'name' => 'pv_num',
@@ -2524,7 +2524,7 @@
},
'27881' => {
'Header' => 'bios_table.h',
- 'Line' => '179',
+ 'Line' => '182',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2539,7 +2539,7 @@
},
'27928' => {
'Header' => 'bios_table.h',
- 'Line' => '171',
+ 'Line' => '174',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2554,7 +2554,7 @@
},
'27975' => {
'Header' => 'bios_table.h',
- 'Line' => '164',
+ 'Line' => '167',
'Param' => {
'0' => {
'name' => 'entry',
@@ -2590,7 +2590,7 @@
'2' => 'rdx'
},
'Return' => '100',
- 'ShortName' => 'pldm_bios_table_string_entry_decode_string_check'
+ 'ShortName' => 'pldm_bios_table_string_entry_decode_string'
},
'28845' => {
'Header' => 'bios_table.h',
@@ -9495,6 +9495,7 @@
'pldm_bios_table_iter_value' => 1,
'pldm_bios_table_pad_checksum_size' => 1,
'pldm_bios_table_string_entry_decode_handle' => 1,
+ 'pldm_bios_table_string_entry_decode_string' => 1,
'pldm_bios_table_string_entry_decode_string_check' => 1,
'pldm_bios_table_string_entry_decode_string_length' => 1,
'pldm_bios_table_string_entry_encode' => 1,
@@ -10336,7 +10337,7 @@
},
'16272' => {
'Header' => 'bios_table.h',
- 'Line' => '208',
+ 'Line' => '211',
'Memb' => {
'0' => {
'name' => 'name_handle',
@@ -10387,7 +10388,7 @@
},
'16385' => {
'Header' => 'bios_table.h',
- 'Line' => '296',
+ 'Line' => '299',
'Memb' => {
'0' => {
'name' => 'name_handle',
@@ -10437,7 +10438,7 @@
},
'16507' => {
'Header' => 'bios_table.h',
- 'Line' => '386',
+ 'Line' => '389',
'Memb' => {
'0' => {
'name' => 'name_handle',
diff --git a/evolutions/current/pldm_bios_table_string_entry_decode_string_check.yaml b/evolutions/current/pldm_bios_table_string_entry_decode_string_check.yaml
new file mode 100644
index 0000000..137a26e
--- /dev/null
+++ b/evolutions/current/pldm_bios_table_string_entry_decode_string_check.yaml
@@ -0,0 +1,2 @@
+- QualifiedName: pldm_bios_table_string_entry_decode_string_check
+ NewName: pldm_bios_table_string_entry_decode_string
diff --git a/include/libpldm/bios_table.h b/include/libpldm/bios_table.h
index 68fb186..1d053a6 100644
--- a/include/libpldm/bios_table.h
+++ b/include/libpldm/bios_table.h
@@ -134,6 +134,9 @@
* may be smaller than the entry's string, in which case the string placed in buffer will
* be truncated (but still NUL terminated).
*/
+int pldm_bios_table_string_entry_decode_string(
+ const struct pldm_bios_string_table_entry *entry, char *buffer,
+ size_t size);
int pldm_bios_table_string_entry_decode_string_check(
const struct pldm_bios_string_table_entry *entry, char *buffer,
size_t size);
diff --git a/meson.build b/meson.build
index b3d28e7..9634b59 100644
--- a/meson.build
+++ b/meson.build
@@ -34,6 +34,7 @@
add_project_arguments('-DLIBPLDM_API_DEPRECATED', language: ['c', 'cpp'])
libpldm_deprecated_aliases += [
['get_fru_record_by_option_check', 'get_fru_record_by_option'],
+ ['pldm_bios_table_string_entry_decode_string_check', 'pldm_bios_table_string_entry_decode_string'],
['pldm_bios_table_string_entry_encode_check', 'pldm_bios_table_string_entry_encode'],
['pldm_entity_association_pdr_add_check', 'pldm_entity_association_pdr_add'],
['pldm_entity_association_pdr_add_from_node_check', 'pldm_entity_association_pdr_add_from_node'],
diff --git a/src/dsp/bios_table.c b/src/dsp/bios_table.c
index 8768ee5..753f7ee 100644
--- a/src/dsp/bios_table.c
+++ b/src/dsp/bios_table.c
@@ -98,7 +98,7 @@
}
LIBPLDM_ABI_STABLE
-int pldm_bios_table_string_entry_decode_string_check(
+int pldm_bios_table_string_entry_decode_string(
const struct pldm_bios_string_table_entry *entry, char *buffer,
size_t size)
{
diff --git a/tests/dsp/bios_table.cpp b/tests/dsp/bios_table.cpp
index e057d90..f23be9a 100644
--- a/tests/dsp/bios_table.cpp
+++ b/tests/dsp/bios_table.cpp
@@ -1028,24 +1028,24 @@
EXPECT_EQ(strLength, 7);
std::vector<char> buffer(strLength + 1, 0);
- pldm_bios_table_string_entry_decode_string_check(entry, buffer.data(),
- buffer.size());
+ pldm_bios_table_string_entry_decode_string(entry, buffer.data(),
+ buffer.size());
EXPECT_EQ(strlen(buffer.data()), strLength);
EXPECT_EQ(std::strcmp("Allowed", buffer.data()), 0);
- EXPECT_EQ(pldm_bios_table_string_entry_decode_string_check(
+ EXPECT_EQ(pldm_bios_table_string_entry_decode_string(
entry, buffer.data(), 2 + 1 /* sizeof '\0'*/),
PLDM_SUCCESS);
EXPECT_EQ(strlen(buffer.data()), 2);
EXPECT_EQ(std::strcmp("Al", buffer.data()), 0);
- auto rc = pldm_bios_table_string_entry_decode_string_check(
- entry, buffer.data(), buffer.size());
+ auto rc = pldm_bios_table_string_entry_decode_string(entry, buffer.data(),
+ buffer.size());
EXPECT_EQ(rc, PLDM_SUCCESS);
EXPECT_EQ(std::strcmp("Allowed", buffer.data()), 0);
/* Ensure equivalence with the unchecked API */
- rc = pldm_bios_table_string_entry_decode_string_check(
- entry, buffer.data(), 2 + 1 /* sizeof '\0' */);
+ rc = pldm_bios_table_string_entry_decode_string(entry, buffer.data(),
+ 2 + 1 /* sizeof '\0' */);
EXPECT_EQ(rc, std::strcmp("Al", buffer.data()));
}
@@ -1116,8 +1116,8 @@
auto str_length = pldm_bios_table_string_entry_decode_string_length(entry);
EXPECT_EQ(str_length, 2);
std::vector<char> strBuf(str_length + 1, 0);
- auto rc = pldm_bios_table_string_entry_decode_string_check(
- entry, strBuf.data(), strBuf.size());
+ auto rc = pldm_bios_table_string_entry_decode_string(entry, strBuf.data(),
+ strBuf.size());
EXPECT_EQ(rc, PLDM_SUCCESS);
EXPECT_EQ(std::strcmp("Hi", strBuf.data()), 0);