add parsing for the <constants> extensions most recently added into Litex

This commit is contained in:
bunnie 2021-03-02 02:05:34 +08:00
parent d1609d2a31
commit c9d7b1c504
4 changed files with 325 additions and 167 deletions

View file

@ -12,6 +12,92 @@
<resetMask>0xFFFFFFFF</resetMask>
<peripherals>
<peripheral>
<name>CPU</name>
<baseAddress>0xF0000000</baseAddress>
<groupName>CPU</groupName>
<registers>
<register>
<name>TIMER_LATCH</name>
<addressOffset>0x0000</addressOffset>
<resetValue>0x00</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_latch</name>
<msb>0</msb>
<bitRange>[0:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
<register>
<name>TIMER_TIME1</name>
<description><![CDATA[Bits 32-63 of `CPU_TIMER_TIME`.]]></description>
<addressOffset>0x0004</addressOffset>
<resetValue>0x00</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_time</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
<register>
<name>TIMER_TIME0</name>
<description><![CDATA[Bits 0-31 of `CPU_TIMER_TIME`.]]></description>
<addressOffset>0x0008</addressOffset>
<resetValue>0x00</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_time</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
<register>
<name>TIMER_TIME_CMP1</name>
<description><![CDATA[Bits 32-63 of `CPU_TIMER_TIME_CMP`.]]></description>
<addressOffset>0x000c</addressOffset>
<resetValue>0x7fffffff</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_time_cmp</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
<register>
<name>TIMER_TIME_CMP0</name>
<description><![CDATA[Bits 0-31 of `CPU_TIMER_TIME_CMP`.]]></description>
<addressOffset>0x0010</addressOffset>
<resetValue>0x7fffffff</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_time_cmp</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
</registers>
<addressBlock>
<offset>0</offset>
<size>0x14</size>
<usage>registers</usage>
</addressBlock>
</peripheral>
<peripheral>
<name>IDENTIFIER_MEM</name>
<baseAddress>0xF0001000</baseAddress>
@ -682,32 +768,6 @@ register to disable individual events.]]></description>
<value>1</value>
</interrupt>
</peripheral>
<peripheral>
<name>UART_PHY</name>
<baseAddress>0xF0006000</baseAddress>
<groupName>UART_PHY</groupName>
<registers>
<register>
<name>TUNING_WORD</name>
<addressOffset>0x0000</addressOffset>
<resetValue>0x4b7f5a</resetValue>
<size>32</size>
<fields>
<field>
<name>tuning_word</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
</registers>
<addressBlock>
<offset>0</offset>
<size>0x4</size>
<usage>registers</usage>
</addressBlock>
</peripheral>
<peripheral>
<name>UART</name>
<baseAddress>0xF0007000</baseAddress>
@ -866,32 +926,6 @@ register to disable individual events.]]></description>
<value>2</value>
</interrupt>
</peripheral>
<peripheral>
<name>CONSOLE_PHY</name>
<baseAddress>0xF0008000</baseAddress>
<groupName>CONSOLE_PHY</groupName>
<registers>
<register>
<name>TUNING_WORD</name>
<addressOffset>0x0000</addressOffset>
<resetValue>0x4b7f5a</resetValue>
<size>32</size>
<fields>
<field>
<name>tuning_word</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
</registers>
<addressBlock>
<offset>0</offset>
<size>0x4</size>
<usage>registers</usage>
</addressBlock>
</peripheral>
<peripheral>
<name>CONSOLE</name>
<baseAddress>0xF0009000</baseAddress>
@ -1050,32 +1084,6 @@ register to disable individual events.]]></description>
<value>3</value>
</interrupt>
</peripheral>
<peripheral>
<name>APP_UART_PHY</name>
<baseAddress>0xF000A000</baseAddress>
<groupName>APP_UART_PHY</groupName>
<registers>
<register>
<name>TUNING_WORD</name>
<addressOffset>0x0000</addressOffset>
<resetValue>0x4b7f5a</resetValue>
<size>32</size>
<fields>
<field>
<name>tuning_word</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
</registers>
<addressBlock>
<offset>0</offset>
<size>0x4</size>
<usage>registers</usage>
</addressBlock>
</peripheral>
<peripheral>
<name>APP_UART</name>
<baseAddress>0xF000B000</baseAddress>
@ -1320,10 +1328,10 @@ register to disable individual events.]]></description>
<register>
<name>GIT_GITREV</name>
<description><![CDATA[First 32-bits of the git revision. This documentation was built from git rev
``e0fc761f``, so this value is 3774641695, which should be enough to check out
``d77dca2f``, so this value is 3615345199, which should be enough to check out
the exact git version used to build this firmware.]]></description>
<addressOffset>0x0014</addressOffset>
<resetValue>0xe0fc761f</resetValue>
<resetValue>0xd77dca2f</resetValue>
<size>32</size>
<fields>
<field>
@ -1340,7 +1348,7 @@ the exact git version used to build this firmware.]]></description>
is ``1``, then the repository this was built from has one additional commit
beyond the tag indicated in `MAJOR`, `MINOR`, and `REVISION`.]]></description>
<addressOffset>0x0018</addressOffset>
<resetValue>0x0a</resetValue>
<resetValue>0x0d</resetValue>
<size>32</size>
<fields>
<field>
@ -3030,7 +3038,7 @@ again until the interrupt is serviced.]]></description>
<name>SEED1</name>
<description><![CDATA[Bits 32-63 of `SEED_SEED`. Seed used for the build]]></description>
<addressOffset>0x0000</addressOffset>
<resetValue>0x156ab1cc</resetValue>
<resetValue>0x48f7dee1</resetValue>
<size>32</size>
<fields>
<field>
@ -3045,7 +3053,7 @@ again until the interrupt is serviced.]]></description>
<name>SEED0</name>
<description><![CDATA[Bits 0-31 of `SEED_SEED`.]]></description>
<addressOffset>0x0004</addressOffset>
<resetValue>0x1918cfd8</resetValue>
<resetValue>0xc2db130</resetValue>
<size>32</size>
<fields>
<field>
@ -5182,5 +5190,34 @@ entered. Defaults to a range of 1.67-5.00 seconds]]></description>
<size>0x00040000</size>
</memoryRegion>
</memoryRegions>
<constants>
<constant name="CONFIG_CLOCK_FREQUENCY" value="100000000" />
<constant name="CONFIG_CPU_HAS_INTERRUPT" value="None" />
<constant name="CONFIG_CPU_RESET_ADDR" value="0" />
<constant name="CONFIG_CPU_TYPE_VEXRISCV" value="None" />
<constant name="CONFIG_CPU_VARIANT_STANDARD" value="None" />
<constant name="CONFIG_CPU_HUMAN_NAME" value="VexRiscv" />
<constant name="CONFIG_CPU_NOP" value="nop" />
<constant name="CONFIG_CSR_DATA_WIDTH" value="32" />
<constant name="CONFIG_CSR_ALIGNMENT" value="32" />
<constant name="CONFIG_BUS_STANDARD" value="WISHBONE" />
<constant name="CONFIG_BUS_DATA_WIDTH" value="32" />
<constant name="CONFIG_BUS_ADDRESS_WIDTH" value="32" />
<constant name="APP_UART_INTERRUPT" value="4" />
<constant name="AUDIO_INTERRUPT" value="10" />
<constant name="BTEVENTS_INTERRUPT" value="7" />
<constant name="COM_INTERRUPT" value="5" />
<constant name="CONSOLE_INTERRUPT" value="3" />
<constant name="ENGINE_INTERRUPT" value="14" />
<constant name="GPIO_INTERRUPT" value="1" />
<constant name="I2C_INTERRUPT" value="6" />
<constant name="KEYBOARD_INTERRUPT" value="9" />
<constant name="SHA512_INTERRUPT" value="13" />
<constant name="TICKTIMER_INTERRUPT" value="8" />
<constant name="TIMER0_INTERRUPT" value="0" />
<constant name="TRNG_KERNEL_INTERRUPT" value="11" />
<constant name="TRNG_SERVER_INTERRUPT" value="12" />
<constant name="UART_INTERRUPT" value="2" />
</constants>
</vendorExtensions>
</device>

View file

@ -12,6 +12,92 @@
<resetMask>0xFFFFFFFF</resetMask>
<peripherals>
<peripheral>
<name>CPU</name>
<baseAddress>0xF0000000</baseAddress>
<groupName>CPU</groupName>
<registers>
<register>
<name>TIMER_LATCH</name>
<addressOffset>0x0000</addressOffset>
<resetValue>0x00</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_latch</name>
<msb>0</msb>
<bitRange>[0:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
<register>
<name>TIMER_TIME1</name>
<description><![CDATA[Bits 32-63 of `CPU_TIMER_TIME`.]]></description>
<addressOffset>0x0004</addressOffset>
<resetValue>0x00</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_time</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
<register>
<name>TIMER_TIME0</name>
<description><![CDATA[Bits 0-31 of `CPU_TIMER_TIME`.]]></description>
<addressOffset>0x0008</addressOffset>
<resetValue>0x00</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_time</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
<register>
<name>TIMER_TIME_CMP1</name>
<description><![CDATA[Bits 32-63 of `CPU_TIMER_TIME_CMP`.]]></description>
<addressOffset>0x000c</addressOffset>
<resetValue>0x7fffffff</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_time_cmp</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
<register>
<name>TIMER_TIME_CMP0</name>
<description><![CDATA[Bits 0-31 of `CPU_TIMER_TIME_CMP`.]]></description>
<addressOffset>0x0010</addressOffset>
<resetValue>0x7fffffff</resetValue>
<size>32</size>
<fields>
<field>
<name>timer_time_cmp</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
</registers>
<addressBlock>
<offset>0</offset>
<size>0x14</size>
<usage>registers</usage>
</addressBlock>
</peripheral>
<peripheral>
<name>IDENTIFIER_MEM</name>
<baseAddress>0xF0001000</baseAddress>
@ -682,32 +768,6 @@ register to disable individual events.]]></description>
<value>1</value>
</interrupt>
</peripheral>
<peripheral>
<name>UART_PHY</name>
<baseAddress>0xF0006000</baseAddress>
<groupName>UART_PHY</groupName>
<registers>
<register>
<name>TUNING_WORD</name>
<addressOffset>0x0000</addressOffset>
<resetValue>0x4b7f5a</resetValue>
<size>32</size>
<fields>
<field>
<name>tuning_word</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
</registers>
<addressBlock>
<offset>0</offset>
<size>0x4</size>
<usage>registers</usage>
</addressBlock>
</peripheral>
<peripheral>
<name>UART</name>
<baseAddress>0xF0007000</baseAddress>
@ -866,32 +926,6 @@ register to disable individual events.]]></description>
<value>2</value>
</interrupt>
</peripheral>
<peripheral>
<name>CONSOLE_PHY</name>
<baseAddress>0xF0008000</baseAddress>
<groupName>CONSOLE_PHY</groupName>
<registers>
<register>
<name>TUNING_WORD</name>
<addressOffset>0x0000</addressOffset>
<resetValue>0x4b7f5a</resetValue>
<size>32</size>
<fields>
<field>
<name>tuning_word</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
</registers>
<addressBlock>
<offset>0</offset>
<size>0x4</size>
<usage>registers</usage>
</addressBlock>
</peripheral>
<peripheral>
<name>CONSOLE</name>
<baseAddress>0xF0009000</baseAddress>
@ -1050,32 +1084,6 @@ register to disable individual events.]]></description>
<value>3</value>
</interrupt>
</peripheral>
<peripheral>
<name>APP_UART_PHY</name>
<baseAddress>0xF000A000</baseAddress>
<groupName>APP_UART_PHY</groupName>
<registers>
<register>
<name>TUNING_WORD</name>
<addressOffset>0x0000</addressOffset>
<resetValue>0x4b7f5a</resetValue>
<size>32</size>
<fields>
<field>
<name>tuning_word</name>
<msb>31</msb>
<bitRange>[31:0]</bitRange>
<lsb>0</lsb>
</field>
</fields>
</register>
</registers>
<addressBlock>
<offset>0</offset>
<size>0x4</size>
<usage>registers</usage>
</addressBlock>
</peripheral>
<peripheral>
<name>APP_UART</name>
<baseAddress>0xF000B000</baseAddress>
@ -1320,10 +1328,10 @@ register to disable individual events.]]></description>
<register>
<name>GIT_GITREV</name>
<description><![CDATA[First 32-bits of the git revision. This documentation was built from git rev
``e0fc761f``, so this value is 3774641695, which should be enough to check out
``d77dca2f``, so this value is 3615345199, which should be enough to check out
the exact git version used to build this firmware.]]></description>
<addressOffset>0x0014</addressOffset>
<resetValue>0xe0fc761f</resetValue>
<resetValue>0xd77dca2f</resetValue>
<size>32</size>
<fields>
<field>
@ -1340,7 +1348,7 @@ the exact git version used to build this firmware.]]></description>
is ``1``, then the repository this was built from has one additional commit
beyond the tag indicated in `MAJOR`, `MINOR`, and `REVISION`.]]></description>
<addressOffset>0x0018</addressOffset>
<resetValue>0x0a</resetValue>
<resetValue>0x0d</resetValue>
<size>32</size>
<fields>
<field>
@ -3030,7 +3038,7 @@ again until the interrupt is serviced.]]></description>
<name>SEED1</name>
<description><![CDATA[Bits 32-63 of `SEED_SEED`. Seed used for the build]]></description>
<addressOffset>0x0000</addressOffset>
<resetValue>0x156ab1cc</resetValue>
<resetValue>0x48f7dee1</resetValue>
<size>32</size>
<fields>
<field>
@ -3045,7 +3053,7 @@ again until the interrupt is serviced.]]></description>
<name>SEED0</name>
<description><![CDATA[Bits 0-31 of `SEED_SEED`.]]></description>
<addressOffset>0x0004</addressOffset>
<resetValue>0x1918cfd8</resetValue>
<resetValue>0xc2db130</resetValue>
<size>32</size>
<fields>
<field>
@ -5182,5 +5190,34 @@ entered. Defaults to a range of 1.67-5.00 seconds]]></description>
<size>0x00040000</size>
</memoryRegion>
</memoryRegions>
<constants>
<constant name="CONFIG_CLOCK_FREQUENCY" value="100000000" />
<constant name="CONFIG_CPU_HAS_INTERRUPT" value="None" />
<constant name="CONFIG_CPU_RESET_ADDR" value="0" />
<constant name="CONFIG_CPU_TYPE_VEXRISCV" value="None" />
<constant name="CONFIG_CPU_VARIANT_STANDARD" value="None" />
<constant name="CONFIG_CPU_HUMAN_NAME" value="VexRiscv" />
<constant name="CONFIG_CPU_NOP" value="nop" />
<constant name="CONFIG_CSR_DATA_WIDTH" value="32" />
<constant name="CONFIG_CSR_ALIGNMENT" value="32" />
<constant name="CONFIG_BUS_STANDARD" value="WISHBONE" />
<constant name="CONFIG_BUS_DATA_WIDTH" value="32" />
<constant name="CONFIG_BUS_ADDRESS_WIDTH" value="32" />
<constant name="APP_UART_INTERRUPT" value="4" />
<constant name="AUDIO_INTERRUPT" value="10" />
<constant name="BTEVENTS_INTERRUPT" value="7" />
<constant name="COM_INTERRUPT" value="5" />
<constant name="CONSOLE_INTERRUPT" value="3" />
<constant name="ENGINE_INTERRUPT" value="14" />
<constant name="GPIO_INTERRUPT" value="1" />
<constant name="I2C_INTERRUPT" value="6" />
<constant name="KEYBOARD_INTERRUPT" value="9" />
<constant name="SHA512_INTERRUPT" value="13" />
<constant name="TICKTIMER_INTERRUPT" value="8" />
<constant name="TIMER0_INTERRUPT" value="0" />
<constant name="TRNG_KERNEL_INTERRUPT" value="11" />
<constant name="TRNG_SERVER_INTERRUPT" value="12" />
<constant name="UART_INTERRUPT" value="2" />
</constants>
</vendorExtensions>
</device>

View file

@ -48,10 +48,17 @@ pub struct MemoryRegion {
pub size: usize,
}
#[derive(Default, Debug)]
pub struct Constant {
pub name: String,
pub value: String,
}
#[derive(Default, Debug)]
pub struct Description {
pub peripherals: Vec<Peripheral>,
pub memory_regions: Vec<MemoryRegion>,
pub constants: Vec<Constant>,
}
impl core::fmt::Display for ParseError {
@ -393,6 +400,56 @@ fn parse_memory_regions<T: BufRead>(
Ok(())
}
fn generate_constants<T: BufRead>(
reader: &mut Reader<T>,
description: &mut Description,
) -> Result<(), ParseError> {
let mut buf = Vec::new();
loop {
match reader.read_event(&mut buf) {
Ok(Event::Empty(ref e)) => match e.name() {
b"constant" => {
let mut constant_descriptor = Constant::default();
for maybe_att in e.attributes() {
match maybe_att {
Ok(att) => {
let att_name = String::from_utf8(att.key.to_vec()).expect("constant: error parsing attribute name");
let att_value = String::from_utf8(att.value.to_vec()).expect("constant: error parsing attribute value");
match att_name {
_ if att_name == "name" => constant_descriptor.name = att_value,
_ if att_name == "value" => constant_descriptor.value = att_value,
_ => panic!("unexpected attribute name")
}
},
_ => panic!("unexpected value in constant: {:?}", maybe_att),
}
}
description
.constants
.push(constant_descriptor)
},
_ => panic!("unexpected tag in <constants>: {:?}", e),
},
// note to future self: if Litex goe away from attributes to nested elements, you would want
// Ok(Event::Start(ref e) => match e.name() ... to descend into the next tag level, and then
// use the tag_name match and extract_contents methods from other functions to generate
// the structure.
// note that the two formats could be mutually exclusively compatible within the same code base:
// if there are no attributes, the attribute iterator would do nothing; and if there are no
// child elements, the recursive descent would also do nothing.
Ok(Event::End(ref e)) => match e.name() {
b"constants" => {
break
}
e => panic!("unhandled value: {:?}", e),
},
Ok(Event::Text(_)) => (),
e => panic!("unhandled value: {:?}", e)
}
}
Ok(())
}
fn parse_vendor_extensions<T: BufRead>(
reader: &mut Reader<T>,
description: &mut Description,
@ -402,6 +459,7 @@ fn parse_vendor_extensions<T: BufRead>(
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => match e.name() {
b"memoryRegions" => parse_memory_regions(reader, description)?,
b"constants" => generate_constants(reader, description)?,
_ => panic!("unexpected tag in <vendorExtensions>: {:?}", e),
},
Ok(Event::End(ref e)) => match e.name() {
@ -581,6 +639,31 @@ fn print_memory_regions<U: Write>(regions: &[MemoryRegion], out: &mut U) -> std:
Ok(())
}
fn print_constants<U: Write>(constants: &[Constant], out: &mut U) -> std::io::Result<()> {
writeln!(out, "\n// Litex auto-generated constants")?;
for constant in constants {
let maybe_intval = constant.value.parse::<u32>();
match maybe_intval {
Ok(intval) => {
writeln!(
out,
"pub const LITEX_{}: usize = {};",
constant.name, intval
)?;
},
Err(_) => {
writeln!(
out,
"pub const LITEX_{}: &str = \"{}\";",
constant.name, constant.value
)?;
}
}
}
writeln!(out)?;
Ok(())
}
fn print_peripherals<U: Write>(peripherals: &[Peripheral], out: &mut U) -> std::io::Result<()> {
writeln!(out, "// Physical base addresses of registers")?;
for peripheral in peripherals {
@ -740,6 +823,7 @@ pub fn generate<T: Read, U: Write>(src: T, dest: &mut U) -> Result<(), ParseErro
print_header(dest).or(Err(ParseError::WriteError))?;
print_memory_regions(&description.memory_regions, dest).or(Err(ParseError::WriteError))?;
print_peripherals(&description.peripherals, dest).or(Err(ParseError::WriteError))?;
print_constants(&description.constants, dest).or(Err(ParseError::WriteError))?;
print_tests(&description.peripherals, dest).or(Err(ParseError::WriteError))?;
Ok(())

View file

@ -44,7 +44,7 @@ fn try_main() -> Result<(), DynError> {
"log-server",
"com",
"xous-names",
"keyboard",
//"keyboard",
"trng",
//"llio",
];