Skip to content

test_development

This tests are designed to validate core aspects of the SVD processing and resolution algorithm and were used during the development of SVDSuite. They are not exhaustive and do not cover all possible edge cases or configurations. Instead, they focus on the fundamental functionality of the SVD processing and resolution algorithm, ensuring that the core features work as intended. It focuses on verifying that peripheral-level definitions and nested algorithmic derivations (including clusters, registers, and inherited enumerated values) are interpreted correctly.

Each test evaluates different facets: - Peripheral level processing: verifying that each peripheral in the SVD is correctly derived and identified with the proper name and base address. - Algorithm functionality: ensuring that nested clusters and registers are processed with the correct hierarchical relationships and default/inherited properties.

test_algorithm

Test Comprehensive SVD Processing Algorithm

This test evaluates the algorithm's ability to resolve and process nested SVD structures, including clusters, registers, and fields with enumerated values. It verifies that the nested hierarchy—involving inherited properties and explicit definitions—is correctly handled.

In this scenario, the SVD file contains peripherals with embedded clusters and registers. The test ensures that: - The nested elements are correctly differentiated (clusters vs. registers). - Inheritance across the hierarchy is applied appropriately. - Default and overridden values are processed as per the SVD standard.

Expected Outcome: - The device should consist of 6 peripherals with proper hierarchical nesting. - Clusters and registers within these peripherals are resolved correctly, with each element having its inherited or explicitly defined properties.

Processable with svdconv: yes

Source code in tests/test_process/test_development.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
@pytest.mark.filterwarnings("error::svdsuite.process.ProcessWarning")
def test_algorithm(get_processed_device_from_testfile: Callable[[str], Device]):
    """
    Test Comprehensive SVD Processing Algorithm

    This test evaluates the algorithm's ability to resolve and process nested SVD structures, including clusters,
    registers, and fields with enumerated values. It verifies that the nested hierarchy—involving inherited properties
    and explicit definitions—is correctly handled.

    In this scenario, the SVD file contains peripherals with embedded clusters and registers. The test ensures that:
    - The nested elements are correctly differentiated (clusters vs. registers).
    - Inheritance across the hierarchy is applied appropriately.
    - Default and overridden values are processed as per the SVD standard.

    **Expected Outcome:**
    - The device should consist of 6 peripherals with proper hierarchical nesting.
    - Clusters and registers within these peripherals are resolved correctly, with each element having its
      inherited or explicitly defined properties.

    **Processable with svdconv:** yes
    """

    device = get_processed_device_from_testfile("development/algorithm.svd")

    assert len(device.peripherals) == 6

    assert device.peripherals[0].name == "ElementA"
    assert device.peripherals[0].base_address == 0x40001000
    assert len(device.peripherals[0].registers_clusters) == 1
    assert isinstance(device.peripherals[0].registers_clusters[0], Cluster)
    assert device.peripherals[0].registers_clusters[0].name == "ClusterA"
    assert len(device.peripherals[0].registers_clusters[0].registers_clusters) == 1
    assert isinstance(device.peripherals[0].registers_clusters[0].registers_clusters[0], Register)
    assert device.peripherals[0].registers_clusters[0].registers_clusters[0].name == "RegisterA"
    assert len(device.peripherals[0].registers_clusters[0].registers_clusters[0].fields) == 1
    assert device.peripherals[0].registers_clusters[0].registers_clusters[0].fields[0].name == "FieldA"
    fielda = device.peripherals[0].registers_clusters[0].registers_clusters[0].fields[0]
    assert len(fielda.enumerated_value_containers) == 1
    assert fielda.enumerated_value_containers[0].name is None

    assert device.peripherals[1].name == "PeripheralA"
    assert device.peripherals[1].base_address == 0x40002000
    assert len(device.peripherals[1].registers_clusters) == 1
    assert isinstance(device.peripherals[1].registers_clusters[0], Cluster)
    assert device.peripherals[1].registers_clusters[0].name == "ElementA"
    assert len(device.peripherals[1].registers_clusters[0].registers_clusters) == 1
    assert isinstance(device.peripherals[1].registers_clusters[0].registers_clusters[0], Cluster)
    assert device.peripherals[1].registers_clusters[0].registers_clusters[0].name == "ClusterA"
    clustera = device.peripherals[1].registers_clusters[0].registers_clusters[0]
    assert len(clustera.registers_clusters) == 1
    assert isinstance(clustera.registers_clusters[0], Register)
    assert clustera.registers_clusters[0].name == "RegisterB"
    assert len(clustera.registers_clusters[0].fields) == 1
    assert clustera.registers_clusters[0].fields[0].name == "FieldA"
    assert len(clustera.registers_clusters[0].fields[0].enumerated_value_containers) == 1
    assert clustera.registers_clusters[0].fields[0].enumerated_value_containers[0].name is None

    assert device.peripherals[2].name == "Peripheral0"
    assert device.peripherals[2].base_address == 0x40003000
    assert len(device.peripherals[2].registers_clusters) == 2
    assert isinstance(device.peripherals[2].registers_clusters[0], Cluster)
    assert device.peripherals[2].registers_clusters[0].name == "ElementA"
    assert len(device.peripherals[2].registers_clusters[0].registers_clusters) == 1
    assert isinstance(device.peripherals[2].registers_clusters[0].registers_clusters[0], Cluster)
    assert device.peripherals[2].registers_clusters[0].registers_clusters[0].name == "ClusterA"
    clustera = device.peripherals[2].registers_clusters[0].registers_clusters[0]
    assert len(clustera.registers_clusters) == 1
    assert isinstance(clustera.registers_clusters[0], Register)
    assert clustera.registers_clusters[0].name == "RegisterB"
    assert len(clustera.registers_clusters[0].fields) == 1
    assert clustera.registers_clusters[0].fields[0].name == "FieldA"
    assert len(clustera.registers_clusters[0].fields[0].enumerated_value_containers) == 1
    assert clustera.registers_clusters[0].fields[0].enumerated_value_containers[0].name is None
    assert isinstance(device.peripherals[2].registers_clusters[1], Cluster)
    assert device.peripherals[2].registers_clusters[1].name == "ClusterA"
    assert len(device.peripherals[2].registers_clusters[1].registers_clusters) == 1
    assert isinstance(device.peripherals[2].registers_clusters[1].registers_clusters[0], Register)
    assert device.peripherals[2].registers_clusters[1].registers_clusters[0].name == "RegisterB"
    assert len(device.peripherals[2].registers_clusters[1].registers_clusters[0].fields) == 1
    assert device.peripherals[2].registers_clusters[1].registers_clusters[0].fields[0].name == "FieldA"
    fielda = device.peripherals[2].registers_clusters[1].registers_clusters[0].fields[0]
    assert len(fielda.enumerated_value_containers) == 1
    assert fielda.enumerated_value_containers[0].name is None

    assert device.peripherals[3].name == "Peripheral1"
    assert device.peripherals[3].base_address == 0x40004000
    assert len(device.peripherals[3].registers_clusters) == 2
    assert isinstance(device.peripherals[3].registers_clusters[0], Cluster)
    assert device.peripherals[3].registers_clusters[0].name == "ElementA"
    assert len(device.peripherals[3].registers_clusters[0].registers_clusters) == 1
    assert isinstance(device.peripherals[3].registers_clusters[0].registers_clusters[0], Cluster)
    assert device.peripherals[3].registers_clusters[0].registers_clusters[0].name == "ClusterA"
    clustera = device.peripherals[3].registers_clusters[0].registers_clusters[0]
    assert len(clustera.registers_clusters) == 1
    assert isinstance(clustera.registers_clusters[0], Register)
    assert clustera.registers_clusters[0].name == "RegisterB"
    assert len(clustera.registers_clusters[0].fields) == 1
    assert clustera.registers_clusters[0].fields[0].name == "FieldA"
    assert len(clustera.registers_clusters[0].fields[0].enumerated_value_containers) == 1
    assert clustera.registers_clusters[0].fields[0].enumerated_value_containers[0].name is None
    assert isinstance(device.peripherals[3].registers_clusters[1], Cluster)
    assert device.peripherals[3].registers_clusters[1].name == "ClusterA"
    assert len(device.peripherals[3].registers_clusters[1].registers_clusters) == 1
    assert isinstance(device.peripherals[3].registers_clusters[1].registers_clusters[0], Register)
    assert device.peripherals[3].registers_clusters[1].registers_clusters[0].name == "RegisterB"
    assert len(device.peripherals[3].registers_clusters[1].registers_clusters[0].fields) == 1
    assert device.peripherals[3].registers_clusters[1].registers_clusters[0].fields[0].name == "FieldA"
    fielda = device.peripherals[3].registers_clusters[1].registers_clusters[0].fields[0]
    assert len(fielda.enumerated_value_containers) == 1
    assert fielda.enumerated_value_containers[0].name is None

    assert device.peripherals[4].name == "PeripheralB"
    assert device.peripherals[4].base_address == 0x40005000
    assert len(device.peripherals[4].registers_clusters) == 1
    assert isinstance(device.peripherals[4].registers_clusters[0], Register)
    assert device.peripherals[4].registers_clusters[0].name == "RegisterA"
    assert len(device.peripherals[4].registers_clusters[0].fields) == 1
    assert device.peripherals[4].registers_clusters[0].fields[0].name == "FieldA"
    assert len(device.peripherals[4].registers_clusters[0].fields[0].enumerated_value_containers) == 1
    assert device.peripherals[4].registers_clusters[0].fields[0].enumerated_value_containers[0].name is None

    assert device.peripherals[5].name == "PeripheralC"
    assert device.peripherals[5].base_address == 0x40006000
    assert len(device.peripherals[5].registers_clusters) == 1
    assert isinstance(device.peripherals[5].registers_clusters[0], Register)
    assert device.peripherals[5].registers_clusters[0].name == "RegisterA"
    assert len(device.peripherals[5].registers_clusters[0].fields) == 1
    assert device.peripherals[5].registers_clusters[0].fields[0].name == "FieldA"
    assert len(device.peripherals[5].registers_clusters[0].fields[0].enumerated_value_containers) == 1
    assert device.peripherals[5].registers_clusters[0].fields[0].enumerated_value_containers[0].name is None
SVD file: development/algorithm.svd
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?xml version='1.0' encoding='utf-8'?>
<device xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="CMSIS-SVD.xsd" schemaVersion="1.3">
  <name>algorithm</name>
  <version>1.0</version>
  <description>Test_Example device</description>
  <cpu>
  <name>CM0</name>
  <revision>r0p0</revision>
  <endian>little</endian>
  <mpuPresent>false</mpuPresent>
  <fpuPresent>false</fpuPresent>
  <nvicPrioBits>4</nvicPrioBits>
  <vendorSystickConfig>false</vendorSystickConfig>
  </cpu>
  <addressUnitBits>8</addressUnitBits>
  <width>32</width>
  <peripherals>
    <peripheral>
      <name>ElementA</name>
      <baseAddress>0x40001000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
      <registers>
        <cluster>
          <name>ClusterA</name>
          <description>ClusterA description</description>
          <addressOffset>0x0</addressOffset>
          <register>
            <name>RegisterA</name>
            <addressOffset>0x0</addressOffset>
            <fields>
              <field>
                <name>FieldA</name>
                <bitOffset>0</bitOffset>
                <bitWidth>1</bitWidth>
                <enumeratedValues>
                  <enumeratedValue>
                    <name>ValueA</name>
                    <description>ValueA description</description>
                    <value>0</value>
                  </enumeratedValue>
                  <enumeratedValue>
                    <name>ValueB</name>
                    <description>ValueB description</description>
                    <value>1</value>
                  </enumeratedValue>
                </enumeratedValues>
              </field>
            </fields>
          </register>
        </cluster>
      </registers>
    </peripheral>
    <peripheral>
      <name>PeripheralA</name>
      <baseAddress>0x40002000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
      <registers>
        <cluster>
          <name>ElementA</name>
          <description>ElementA description</description>
          <addressOffset>0x0</addressOffset>
          <cluster>
            <name>ClusterA</name>
            <description>ClusterA description</description>
            <addressOffset>0x0</addressOffset>
            <register derivedFrom="ElementA.ClusterA.RegisterA">
              <name>RegisterB</name>
              <addressOffset>0x0</addressOffset>
            </register>
          </cluster>
        </cluster>
      </registers>
    </peripheral>
    <peripheral derivedFrom="PeripheralA">
      <dim>2</dim>
      <dimIncrement>0x1000</dimIncrement>
      <name>Peripheral[%s]</name>
      <baseAddress>0x40003000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
      <registers>
        <cluster derivedFrom="ElementA.ClusterA">
          <name>ClusterA</name>
          <description>ClusterA description</description>
          <addressOffset>0x4</addressOffset>
        </cluster>
      </registers>
    </peripheral>
    <peripheral>
      <name>PeripheralB</name>
      <baseAddress>0x40005000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
      <registers>
        <register derivedFrom="Peripheral1.ClusterA.RegisterB">
          <name>RegisterA</name>
          <addressOffset>0x0</addressOffset>
        </register>
      </registers>
    </peripheral>
    <peripheral>
      <name>PeripheralC</name>
      <baseAddress>0x40006000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
      <registers>
        <register derivedFrom="Peripheral[%s].ClusterA.RegisterB">
          <name>RegisterA</name>
          <addressOffset>0x0</addressOffset>
        </register>
      </registers>
    </peripheral>
  </peripherals>
</device>

test_peripheral_level

Test Peripheral Level Processing

This test validates that the parser correctly processes the peripheral definitions within an SVD file. It ensures that: - The device object contains the expected number of peripherals. - Each peripheral is assigned the correct name and base address as described in the SVD.

This is critical to confirm that higher-level elements are correctly extracted prior to further processing of registers and clusters.

Expected Outcome: - The device should include 14 peripherals. - Each peripheral must have the expected name and base address as defined.

Processable with svdconv: no - svdconv does not support forward references

Source code in tests/test_process/test_development.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
@pytest.mark.filterwarnings("error::svdsuite.process.ProcessWarning")
def test_peripheral_level(get_processed_device_from_testfile: Callable[[str], Device]):
    """
    Test Peripheral Level Processing

    This test validates that the parser correctly processes the peripheral definitions within an SVD file.
    It ensures that:
    - The device object contains the expected number of peripherals.
    - Each peripheral is assigned the correct name and base address as described in the SVD.

    This is critical to confirm that higher-level elements are correctly extracted prior to further processing of
    registers and clusters.

    **Expected Outcome:**
    - The device should include 14 peripherals.
    - Each peripheral must have the expected name and base address as defined.

    **Processable with svdconv:** no - svdconv does not support forward references
    """

    device = get_processed_device_from_testfile("development/peripheral_level.svd")

    assert len(device.peripherals) == 14

    assert device.peripherals[0].name == "PeripheralA0"
    assert device.peripherals[0].base_address == 0x40001000

    assert device.peripherals[1].name == "PeripheralA1"
    assert device.peripherals[1].base_address == 0x40002000

    assert device.peripherals[2].name == "PeripheralB"
    assert device.peripherals[2].base_address == 0x40003000

    assert device.peripherals[3].name == "PeripheralC0"
    assert device.peripherals[3].base_address == 0x40004000

    assert device.peripherals[4].name == "PeripheralC1"
    assert device.peripherals[4].base_address == 0x40005000

    assert device.peripherals[5].name == "PeripheralD"
    assert device.peripherals[5].base_address == 0x40006000

    assert device.peripherals[6].name == "PeripheralE0"
    assert device.peripherals[6].base_address == 0x40007000

    assert device.peripherals[7].name == "PeripheralE1"
    assert device.peripherals[7].base_address == 0x40008000

    assert device.peripherals[8].name == "PeripheralF"
    assert device.peripherals[8].base_address == 0x40009000

    assert device.peripherals[9].name == "PeripheralG0"
    assert device.peripherals[9].base_address == 0x4000A000

    assert device.peripherals[10].name == "PeripheralG1"
    assert device.peripherals[10].base_address == 0x4000B000

    assert device.peripherals[11].name == "PeripheralH"
    assert device.peripherals[11].base_address == 0x4000C000

    assert device.peripherals[12].name == "PeripheralI"
    assert device.peripherals[12].base_address == 0x4000D000

    assert device.peripherals[13].name == "PeripheralJ"
    assert device.peripherals[13].base_address == 0x4000E000
SVD file: development/peripheral_level.svd
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<?xml version='1.0' encoding='utf-8'?>
<device xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="CMSIS-SVD.xsd" schemaVersion="1.3">
  <name>test</name>
  <version>1.0</version>
  <description>Test_Example device</description>
  <cpu>
  <name>CM0</name>
  <revision>r0p0</revision>
  <endian>little</endian>
  <mpuPresent>false</mpuPresent>
  <fpuPresent>false</fpuPresent>
  <nvicPrioBits>4</nvicPrioBits>
  <vendorSystickConfig>false</vendorSystickConfig>
  </cpu>
  <addressUnitBits>8</addressUnitBits>
  <width>32</width>
  <peripherals>
    <peripheral>
      <dim>2</dim>
      <dimIncrement>0x1000</dimIncrement>
      <name>PeripheralA[%s]</name>
      <baseAddress>0x40001000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
      <registers>
        <register>
          <name>RegisterA</name>
          <addressOffset>0x0</addressOffset>
        </register>
        <register>
          <name>RegisterB</name>
          <addressOffset>0x4</addressOffset>
        </register>
      </registers>
    </peripheral>
    <peripheral derivedFrom="PeripheralE1">
      <name>PeripheralB</name>
      <baseAddress>0x40003000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
    </peripheral>
    <peripheral derivedFrom="PeripheralE[%s]">
      <name>PeripheralC[%s]</name>
      <baseAddress>0x40004000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
    </peripheral>
    <peripheral>
      <name>PeripheralD</name>
      <baseAddress>0x40006000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
      <registers>
        <register>
          <name>RegisterA</name>
          <addressOffset>0x0</addressOffset>
        </register>
        <register>
          <name>RegisterB</name>
          <addressOffset>0x4</addressOffset>
        </register>
      </registers>
    </peripheral>
    <peripheral derivedFrom="PeripheralG[%s]">
      <name>PeripheralE[%s]</name>
      <baseAddress>0x40007000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
    </peripheral>
    <peripheral derivedFrom="PeripheralC0">
      <name>PeripheralF</name>
      <baseAddress>0x40009000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
    </peripheral>
    <peripheral>
      <dim>2</dim>
      <dimIncrement>0x1000</dimIncrement>
      <name>PeripheralG[%s]</name>
      <baseAddress>0x4000a000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
      <registers>
        <register>
          <name>RegisterA</name>
          <addressOffset>0x0</addressOffset>
        </register>
        <register>
          <name>RegisterB</name>
          <addressOffset>0x4</addressOffset>
        </register>
      </registers>
    </peripheral>
    <peripheral derivedFrom="PeripheralE1">
      <name>PeripheralH</name>
      <baseAddress>0x4000c000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
    </peripheral>
    <peripheral>
      <name>PeripheralI</name>
      <baseAddress>0x4000d000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
      <registers>
        <register>
          <name>RegisterA</name>
          <addressOffset>0x0</addressOffset>
        </register>
        <register>
          <name>RegisterB</name>
          <addressOffset>0x4</addressOffset>
        </register>
      </registers>
    </peripheral>
    <peripheral derivedFrom="PeripheralI">
      <name>PeripheralJ</name>
      <baseAddress>0x4000e000</baseAddress>
      <addressBlock>
        <offset>0x0</offset>
        <size>0x1000</size>
        <usage>registers</usage>
      </addressBlock>
    </peripheral>
  </peripherals>
</device>