Create FORTH code for register definitions of ARM Cortex-M devices based on its CMSIS SVD XML description
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
README.md
cm-devices.fth
convert.sh
extract.xsl

README.md

cmsis-svd-fth

What is this all about?

Create FORTH code for register definitions of ARM Cortex-M devices based on its CMSIS SVD XML description.

Every ARM Cortex-M Device has plenty of integrated devices like Timers, CRC Units, GPIO portzs and so on. These devices are configured through up to hundred or more registers, each possible split up into a set og bitfields. Even worse, names and meaning differ from one vendor through the other. Even if we have a datasheet, bit-mangling code is not really readable if we don't have the names of the registers as defined by the vendor.

One may define them by hand as needed, but there is a better way: CMSIS SVD.

The "Cortex® Microcontroller Software Interface Standard - System View Description" is a XML specification for Cortex-M devices and their register layout.

This repo provides a XSL stylesheet to translate a SVD file into some FORTH code to acces the registers by name.

A later addition will even provide ways to access the various bitfields inside the registers by name in FORTH code.

ATTENTION: the code here is bleeding edge - it has worked exactly once for exactly one SVD file.

Usage

Needed Software

This code is targeted to a Unix-like environment, with the follwing tools available:

  • xsltproc
  • bash and sed to run the script

Tested on Linux and Cygwin on Windows, both are fine.

How to create and use the forth code

To use this code, you need to perform the following steps:

  1. Download the SVD files for your target CPU. On place to find them is on the ARM Website. This needs a simple registration.
  2. Create the FORTH code for the register definitions by running convert.sh file.svd > file.fth.
  3. Include cm-devices.fth into your FORTH project.
  4. Include the generated file.fth