Skip to content

[svdconv] Correct enum combo width warning #2584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thorstendb-ARM merged 1 commit into from
Aug 31, 2026
Merged

[svdconv] Correct enum combo width warning #2584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion tools/svdconv/SVDGenerator/src/SfdData_SingleItems.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -954,7 +954,11 @@ bool SfdData::CreateFieldItem(SvdField* field)
if(bitWidth > MAX_BITWIDTH_FOR_COMBO && firstContHasChilds) {
string msg = "Enumerated values list for field '";
msg += field->GetNameCalculated();
msg += "' exceeds maximum of 256 elements. List will not be generated.";
msg += "' will not be generated: field width ";
msg += to_string(bitWidth);
msg += " exceeds the maximum of ";
msg += to_string(MAX_BITWIDTH_FOR_COMBO);
msg += " bits.";
LogMsg("M227", MSG(msg), field->GetLineNumber());
}

Expand Down
75 changes: 75 additions & 0 deletions tools/svdconv/test/data/enumComboWidth/EnumComboWidth.svd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>

<device schemaVersion="1.1"
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance"
xs:noNamespaceSchemaLocation="CMSIS-SVD_Schema_1_1.xsd">
<name>EnumComboWidth</name>
<version>1.0</version>
<description>Test the SFD combo field width limit</description>
<addressUnitBits>8</addressUnitBits>
<width>32</width>
<size>0x20</size>
<resetValue>0x0</resetValue>
<resetMask>0xFFFFFFFF</resetMask>

<cpu>
<name>CM4</name>
<revision>r0p0</revision>
<endian>little</endian>
<fpuPresent>false</fpuPresent>
<nvicPrioBits>4</nvicPrioBits>
<deviceNumInterrupts>16</deviceNumInterrupts>
</cpu>

<peripherals>
<peripheral>
<name>TEST</name>
<description>Test peripheral</description>
<groupName>Enum Combo Width</groupName>
<baseAddress>0x40000000</baseAddress>
<addressBlock>
<offset>0x0</offset>
<size>0x4</size>
<usage>registers</usage>
</addressBlock>
<registers>
<register>
<name>CTRL</name>
<description>Test control register</description>
<addressOffset>0x0</addressOffset>
<size>0x20</size>
<access>read-only</access>
<resetValue>0x0</resetValue>
<fields>
<field>
<name>SIX_BIT</name>
<description>Six bit field</description>
<bitOffset>0</bitOffset>
<bitWidth>6</bitWidth>
<enumeratedValues>
<enumeratedValue>
<name>ONE</name>
<description>Value one</description>
<value>1</value>
</enumeratedValue>
</enumeratedValues>
</field>
<field>
<name>SEVEN_BIT</name>
<description>Seven bit field</description>
<bitOffset>8</bitOffset>
<bitWidth>7</bitWidth>
<enumeratedValues>
<enumeratedValue>
<name>NINE</name>
<description>Value nine</description>
<value>9</value>
</enumeratedValue>
</enumeratedValues>
</field>
</fields>
</register>
</registers>
</peripheral>
</peripherals>
</device>
50 changes: 50 additions & 0 deletions tools/svdconv/test/integtests/src/SvdConvIntegTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,53 @@ TEST_F(SvdConvIntegTests, CheckPosMaskDimFields) {
EXPECT_EQ(string::npos, buf.find("#define TIM_DATA_PIN_Pos"));
EXPECT_EQ(string::npos, buf.find("#define TIM_DATA_PIN_Msk"));
}

TEST_F(SvdConvIntegTests, CheckEnumComboWidthLimit) {
const string& inFile = SvdConvIntegTestEnv::localtestdata_dir + "/enumComboWidth/EnumComboWidth.svd";
const string testOut = SvdConvIntegTestEnv::testoutput_dir + "/enumComboWidth";
ASSERT_TRUE(RteFsUtils::Exists(inFile));

Arguments args("SVDConv.exe", inFile);
args.add({ "-o", testOut, "--generate=sfd", "--create-folder" });

SvdConv svdConv;
EXPECT_EQ(1, svdConv.Check(args, args, nullptr));

const auto msgs = ErrLog::Get()->GetLogMessages();
size_t m227Count = 0;
string allMessages;
for(const auto& msg : msgs) {
allMessages += msg;
if(msg.find("M227") != string::npos) {
++m227Count;
}
}
EXPECT_EQ(1U, m227Count);
EXPECT_NE(string::npos, allMessages.find("field 'SEVEN_BIT'"));
EXPECT_NE(string::npos, allMessages.find("field width 7"));
EXPECT_NE(string::npos, allMessages.find("maximum of 6 bits"));

const string testOutSfd = testOut + "/EnumComboWidth.sfd";
ASSERT_TRUE(RteFsUtils::Exists(testOutSfd));

string buf;
RteFsUtils::ReadFile(testOutSfd, buf);
ASSERT_FALSE(buf.empty());

const auto sixBitField = buf.find("SFDITEM_FIELD__TEST_CTRL_SIX_BIT");
const auto sevenBitField = buf.find("SFDITEM_FIELD__TEST_CTRL_SEVEN_BIT");
ASSERT_NE(string::npos, sixBitField);
ASSERT_NE(string::npos, sevenBitField);
ASSERT_LT(sixBitField, sevenBitField);

const auto sixBitCombo = buf.find("// <combo>", sixBitField);
EXPECT_NE(string::npos, sixBitCombo);
EXPECT_LT(sixBitCombo, sevenBitField);
const auto sixBitLastValue = buf.find("// <63=>", sixBitCombo);
EXPECT_NE(string::npos, sixBitLastValue);
EXPECT_LT(sixBitLastValue, sevenBitField);

const auto sevenBitEdit = buf.find("// <edit>", sevenBitField);
EXPECT_NE(string::npos, sevenBitEdit);
EXPECT_EQ(string::npos, buf.find("// <combo>", sevenBitField));
}
Loading