Skip to content

Support for Multiple Peripheral's Address Blocks#159

Merged
posborne merged 1 commit intocmsis-svd:masterfrom
VincentDary:support_for_multiple_peripheral_address_blocks
Oct 14, 2022
Merged

Support for Multiple Peripheral's Address Blocks#159
posborne merged 1 commit intocmsis-svd:masterfrom
VincentDary:support_for_multiple_peripheral_address_blocks

Conversation

@VincentDary
Copy link
Copy Markdown
Member

@VincentDary VincentDary commented Sep 5, 2022

According to the official CMSIS-SVD XML file format description this is possible to have multiple AddressBlock in the peripheral description. This seem logical since a peripheral can have multiple reserved blocks localized at different offsets in the peripheral address range.

/device/peripherals/peripheral/addressBlock element
Specify an address range uniquely mapped to this peripheral. A peripheral must have at least one address block.*

(https://www.keil.com/pack/doc/CMSIS/SVD/html/elem_peripherals.html#elem_addressBlock)

For example, the Thoshiba/M367.svd description file contains several PL011 peripherals which contains multiple AddressBlock.

Thoshiba/M367.svd (https://github.com/posborne/cmsis-svd/blob/master/data/Toshiba/M367.svd#L2859) extract for UART4:

<peripheral>
  <name>UART4</name>
  <description>ARM Prime Cell PL011</description>
  <baseAddress>0x40048000</baseAddress>
  <addressBlock>
    <offset>0x0</offset>
    <size>0x8</size>
    <usage>registers</usage>
  </addressBlock>
  <addressBlock>
    <offset>0x8</offset>
    <size>0x10</size>
    <usage>reserved</usage>
  </addressBlock>
  <addressBlock>
    <offset>0x18</offset>
    <size>0x4</size>
    <usage>registers</usage>
  </addressBlock>
  <addressBlock>
    <offset>0x1c</offset>
    <size>0x4</size>
    <usage>reserved</usage>
  </addressBlock>
  <addressBlock>
    <offset>0x20</offset>
    <size>0x2c</size>
    <usage>registers</usage>
  </addressBlock>

Here an extract of the Summary of registers of the PL011 documention (ARM DDI 0183G https://documentation-service.arm.com/static/5e8e36c2fd977155116a90b5) corresponding to the registers of the UARTx peripherals of the Thoshiba/M367.svd.

Offset      Name      Type    Reset         Width     Description
-----------------------------------------------------------------------------------------------------
0x000       UARTDR    RW      0x---         12/8      Data Register, UARTDR on page 3-5
-----------------------------------------------------------------------------------------------------
0x004       UARTRSR   RW      0x0           4/0       Receive Status Register/Error Clear Register,
            /UARTECR                                  UARTRSR/UARTECR on page 3-6
-----------------------------------------------------------------------------------------------------
0x008-0x014 -         -       -             -         Reserved
-----------------------------------------------------------------------------------------------------
0x018       UARTFR    RO      0b-10010---   9         Flag Register, UARTFR on page 3-8
-----------------------------------------------------------------------------------------------------
0x01C       -         -       -             -         Reserved
-----------------------------------------------------------------------------------------------------
0x020       UARTILPR  RW      0x00          8         IrDA Low-Power Counter Register, UARTILPR on
                                                      page 3-9
[...]

The patch fix the parser and the model to have a new field address_blocks in the SVDPeripheral structure. The patch remove the address_block field. Exemple with the UART4 (PL011) peripheral of the Thoshiba/M367.svd.

>> from cmsis_svd.parser import SVDParser
>> parser = SVDParser.for_packaged_svd('Toshiba', 'M367.svd')
>>> parser.get_device().peripherals[5].name
'UART4'
>>> parser.get_device().peripherals[5].description
'ARM Prime Cell PL011'
>>> for address_block in parser.get_device().peripherals[5].address_blocks:
...     print('offset: {:#0x}, size: {:#0x}, usage: {}'.format(address_block.offset, address_block.size, address_block.usage))
offset: 0x0, size: 0x8, usage: registers
offset: 0x8, size: 0x10, usage: reserved
offset: 0x18, size: 0x4, usage: registers
offset: 0x1c, size: 0x4, usage: reserved
offset: 0x20, size: 0x2c, usage: registers

The tests and test fixture (MKL25Z4.json) are fixed and all the tests passe with success.

posborne
posborne approved these changes Oct 14, 2022
View reviewed changes
Copy link
Copy Markdown
Collaborator

@posborne posborne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @VincentDary, LGTM.

@posborne posborne merged commit 4c7b2c2 into cmsis-svd:master Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@posborne posborne posborne approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@VincentDary @posborne