summaryrefslogtreecommitdiffstats
path: root/utils/regtools/desc/XML.txt
diff options
context:
space:
mode:
authorAmaury Pouly <amaury.pouly@gmail.com>2014-12-14 11:53:55 +0100
committerAmaury Pouly <amaury.pouly@gmail.com>2015-09-11 16:40:19 +0200
commit1cada1f8339d6b5f8506277f80e62aaef77ab774 (patch)
tree8477120e97832d659d2ffc471a8bfde73ad4c36e /utils/regtools/desc/XML.txt
parentc8d3638b9ebc24e4766714da1c9f961e350799c6 (diff)
downloadrockbox-1cada1f8339d6b5f8506277f80e62aaef77ab774.tar.gz
rockbox-1cada1f8339d6b5f8506277f80e62aaef77ab774.zip
soc_desc: new version of the desc file format
Fix qeditor to use the old soc_desc_v1. Port hwstub_shell to the new description format. Change-Id: I9fefbff534bfaa5c3603bb3dd8307a2b76e88cfc
Diffstat (limited to 'utils/regtools/desc/XML.txt')
-rw-r--r--utils/regtools/desc/XML.txt140
1 files changed, 0 insertions, 140 deletions
diff --git a/utils/regtools/desc/XML.txt b/utils/regtools/desc/XML.txt
deleted file mode 100644
index 3c28154a1f..0000000000
--- a/utils/regtools/desc/XML.txt
+++ /dev/null
@@ -1,140 +0,0 @@
-This file describes the format of the register map based on XML.
-
-Root
-----
-As any XML document, the content of the file should be enclosed in a "xml" tag.
-
-Example:
-<?xml version="1.0"?>
-<!-- desc -->
-</xml>
-
-Root Element: root
-------------------
-The root element can either be "soc" tag if the file contains a single description,
-or "root" with no properties and one or more "soc" tags as children.
-
-Element: soc
-------------
-The XML can contain one or more SoC description. Each description is enclosed in
-a "soc" tag. The following properties are defined:
-- "name" (mandatory,string): the mnemonic of the SoC.
-- "desc" (optional,string): a textual description of the SoC.
-
-Example:
-<soc name="stmp3700" desc="STMP3700">
-<!-- soc desc -->
-</soc>
-
-Element: soc.dev
-----------------
-Each SoC can contain any number of devices. Each device is enclosed in a "dev"
-tag. A device is logical group of registers and doesn't have a precise meaning.
-If a SoC has several copies of the same device at different addresses (SSP1, SSP2
-for example), then only one copy has to be described since a device can have
-several address (see soc.dev.addr section). The following properties are defined:
-- "name" (mandatory,string): the mnemonic of the device.
-- "long_name" (optional,string): a short description of the device.
-- "desc" (optional,string): a long description of the SoC.
-- "version" (optional,string): version of the register description for this device.
-
-Example:
-<dev name="APBH" long_name="APHB DMA" desc="AHB-to-APBH Bridge with DMA" version="3.2.0">
-<!-- dev desc>
-</dev>
-
-Element: soc.dev.addr
----------------------
-Each device can have one or more addresses associated with it. Each address is
-enclosed in a "addr" tag. This allows to describe several blocks are once on SoCs
-where several copies of the same block exist at different addresses.
-The following properties are defined:
-- "name" (mandatory,string): unique name of this instance of the device.
-- "addr" (mandatory,integer): base address of this instance of the device.
-
-Example:
-<addr name="SSP1" addr="0x80010000" />
-<addr name="SSP2" addr="0x80034000" />
-
-Element: soc.dev.reg
---------------------
-Each device can contain any number of registers. Each register is enclosed in a
-"reg" tag. If a SoC has several copies of the same register at different addresses
-(INTERRUPT0, INTERRUPT1 for example), then only one copy has to be described since
-a register can have several address (see soc.dev.reg.addr section).
-The following properties are defined:
-- "name" (mandatory,string): the mnemonic of the register.
-- "sct" (optional,"yes" or "no"): STMP specific attribute to specify the existence
- of the SCT variants of this register.
-As a shortcut, in the case the register has a single address, one can add one more
-property:
-- "addr" (optional,integer): base address of this instance of the register.
-
-Example:
-<reg name="TIMCTRLn" sct="yes">
-<!-- reg desc -->
-</reg>
-
-The address shortcut has the following standard translation:
-<reg name="GPIO_PADR" addr="0x00">
-<!-- bla -->
-</reg>
-is equivalent to:
-<reg name="GPIO_PADR">
-<addr name="GPIO_PADR" addr="0x00">
-<!-- bla -->
-</reg>
-
-Element: soc.dev.reg.addr
--------------------------
-Each device can have one or more addresses associated with it. Each address
-is enclosed in a "addr" tag. This allows to describe several register at once on
-SoCs where a similar register is replicated several times.
-The following properties are defined:
-- "name" (mandatory,string): unique name of this instance of the register.
-- "addr" (mandatory,integer): base address of this instance of the register.
-
-Example:
-<addr name="TIMCTRL0" addr="0x20" />
-<addr name="TIMCTRL1" addr="0x40" />
-<addr name="TIMCTRL2" addr="0x60" />
-
-Element: soc.dev.reg.formula
-----------------------------
-In the special case where the addresses of the register follow a pattern, an
-explicit formula can be described as part of the format. There is no specific
-requirement on the formula except that the register addresses be indexed by
-a variable "n" which range from 0 to N-1 where N is the number of address.
-The formula is not used for anything except header generation where it is
-handy to have a formula rather a long list of conditionals.
-The following properties are defined:
-- "string" (mandatory,string): the equation describing the addresses.
-
-Example:
-<formula string="0x20+n*0x20"/>
-
-Element: soc.dev.reg.field
---------------------------
-Each register can be further divided into disjoints fields. Each field
-is enclosed in a "field" tag. A field is defined as a contiguous set
-of bits in the register. The following properties are defined:
-- "name" (mandatory,string): the mnemonic of field
-- "bitrange" (mandatory,string): the bit range of the field written as
- "n-m" where n and m are integers giving the most (resp. least) significant
- bit of the field.
-
-Example:
-<field name="PRESCALE" bitrange="5:4">
-<!-- field desc -->
-</field>
-
-Element: soc.dev.reg.field.value
---------------------------------
-Each field can describe a list of named values in cases where this is appropriate.
-Each value is enclosed in a "value" tag. The following properties are defined:
-- "name" (mandatory,string): the mnemonic of the value.
-- "value" (mandatory,integer): the associated value.
-
-Example:
-<value name="DIV_BY_1" value="0x0" />
-<value name="DIV_BY_2" value="0x1" />