utra: fix build on non-hardware release

This adds svd2utra, which enables building for non-embedded harware.

It also fixes some build issues, and paves the way for generating UTRA
at compile-time.

Signed-off-by: Sean Cross <sean@xobs.io>
This commit is contained in:
Sean Cross 2020-10-05 10:13:51 +08:00
parent 15e5b674d1
commit d0d687a239
14 changed files with 5606 additions and 9 deletions

2
.gitignore vendored
View file

@ -2,7 +2,7 @@
/kernel/target
/loader/target
**/*.rs.bk
/utra/utra
/utra
# Emacs
*~

17
Cargo.lock generated
View file

@ -407,6 +407,15 @@ version = "1.2.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a1d01941d82fa2ab50be1e79e6714289dd7cde78eba4c074bc5a4374f650dfe0"
[[package]]
name = "quick-xml"
version = "0.19.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b3d72d5477478f85bd00b6521780dfba1ec6cdaadcf90b8b181c36d7de561f9b"
dependencies = [
"memchr",
]
[[package]]
name = "quote"
version = "1.0.7"
@ -705,6 +714,7 @@ version = "0.1.0"
dependencies = [
"bitflags",
"graphics-server",
"utra",
"xous",
]
@ -720,6 +730,13 @@ version = "0.8.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a"
[[package]]
name = "svd2utra"
version = "0.1.0"
dependencies = [
"quick-xml",
]
[[package]]
name = "syn"
version = "1.0.38"

View file

@ -6,8 +6,8 @@ members = [
"examples/shell",
"examples/graphics-server",
"examples/log-server",
"svd2utra",
"xtask",
"utra/utra"
]
default-members = [
"examples/shell",
@ -22,9 +22,12 @@ default-members = [
exclude = [
"kernel",
"loader",
# Exclude UTRA, since it is machine-generated.
"utra",
]
[profile.release]
codegen-units = 1 # 1 better optimizations
debug = true # symbols are nice and they don't increase the size on Flash
lto = "thin"
#lto = "thin"

View file

@ -1 +0,0 @@
/home/bunnie/code/betrusted-soc/build/csr.csv
1 /home/bunnie/code/betrusted-soc/build/csr.csv #--------------------------------------------------------------------------------
/home/bunnie/code/betrusted-soc/build/csr.csv

169
emulation/csr.csv Normal file
View file

@ -0,0 +1,169 @@
#--------------------------------------------------------------------------------
# Auto-generated by Migen (e2e6c72) & LiteX (18a9d4f) on 2020-02-15 23:31:38
#--------------------------------------------------------------------------------
csr_base,sram_ext,0xf0004000,,
csr_base,ticktimer,0xf0007000,,
csr_base,messible,0xf0006800,,
csr_base,keyboard,0xf0008800,,
csr_base,power,0xf0007800,,
csr_base,info,0xf0003800,,
csr_base,reboot,0xf0002800,,
csr_base,timer0,0xf0002000,,
csr_base,uart_phy,0xf0001000,,
csr_base,gpio,0xf0009000,,
csr_base,trng_osc,0xf000b000,,
csr_base,seed,0xf0009800,,
csr_base,i2c,0xf0005800,,
csr_base,romtest,0xf000a000,,
csr_base,crg,0xf0003000,,
csr_base,btevents,0xf0006000,,
csr_base,spinor,0xf0008000,,
csr_base,audio,0xf000a800,,
csr_base,ctrl,0xf0000000,,
csr_base,uart,0xf0001800,,
csr_base,memlcd,0xf0005000,,
csr_base,com,0xf000c000,,
csr_register,i2c_prescale,0xf0005800,1,rw
csr_register,messible_in,0xf0006800,1,rw
csr_register,i2c_command,0xf0005810,1,rw
csr_register,btevents_ev_pending,0xf0006004,1,rw
csr_register,uart_ev_status,0xf000180c,1,rw
csr_register,i2c_txr,0xf0005808,1,rw
csr_register,info_xadc_drp_write,0xf000384c,1,rw
csr_register,info_platform_platform,0xf000381c,2,ro
csr_register,uart_phy_tuning_word,0xf0001000,1,rw
csr_register,keyboard_row1dat,0xf0008804,1,ro
csr_register,i2c_rxr,0xf000580c,1,ro
csr_register,keyboard_row6dat,0xf0008818,1,ro
csr_register,audio_tx_stat,0xf000a818,1,ro
csr_register,keyboard_rowchange,0xf0008830,1,ro
csr_register,info_xadc_drp_dat_w,0xf0003858,1,rw
csr_register,spinor_ecc_status,0xf0008028,1,ro
csr_register,uart_ev_enable,0xf0001814,1,rw
csr_register,audio_ev_pending,0xf000a804,1,rw
csr_register,messible_out,0xf0006804,1,ro
csr_register,keyboard_row0dat,0xf0008800,1,ro
csr_register,info_xadc_drp_dat_r,0xf000385c,1,ro
csr_register,info_xadc_vccint,0xf0003830,1,ro
csr_register,ticktimer_time,0xf0007004,2,ro
csr_register,keyboard_row7dat,0xf000881c,1,ro
csr_register,info_xadc_drp_enable,0xf0003844,1,rw
csr_register,spinor_command,0xf000800c,1,rw
csr_register,btevents_ev_enable,0xf0006008,1,rw
csr_register,timer0_ev_pending,0xf0002018,1,rw
csr_register,sram_ext_config_status,0xf0004000,1,ro
csr_register,timer0_reload,0xf0002004,1,rw
csr_register,timer0_load,0xf0002000,1,rw
csr_register,info_xadc_vccaux,0xf0003834,1,ro
csr_register,messible_status,0xf0006808,1,ro
csr_register,romtest_data,0xf000a004,1,ro
csr_register,memlcd_ev_enable,0xf0004814,1,rw
csr_register,i2c_control,0xf0005804,1,rw
csr_register,info_git_commit,0xf0003808,5,ro
csr_register,seed_seed,0xf0009800,2,ro
csr_register,info_xadc_temperature,0xf000382c,1,ro
csr_register,reboot_addr,0xf0002804,1,rw
csr_register,timer0_value,0xf0002010,1,ro
csr_register,crg_mmcm_drp_read,0xf0003008,1,rw
csr_register,crg_mmcm_drp_adr,0xf0003014,1,rw
csr_register,spinor_ev_status,0xf0008018,1,rw
csr_register,com_tx,0xf0005000,1,rw
csr_register,gpio_ev_pending,0xf0009018,1,rw
csr_register,crg_mmcm_drp_locked,0xf0003004,1,ro
csr_register,memlcd_Busy,0xf0004804,1,ro
csr_register,info_xadc_eos,0xf0003840,1,ro
csr_register,spinor_sector,0xf0008010,1,rw
csr_register,gpio_intena,0xf000900c,1,ro
csr_register,timer0_update_value,0xf000200c,1,rw
csr_register,gpio_drive,0xf0009008,1,rw
csr_register,uart_txfull,0xf0001804,1,ro
csr_register,trng_osc_ctl,0xf000b000,1,rw
csr_register,spinor_status,0xf0008014,1,ro
csr_register,sram_ext_read_config,0xf0004004,1,rw
csr_register,gpio_intpol,0xf0009010,1,ro
csr_register,keyboard_ev_status,0xf0008824,1,rw
csr_register,audio_tx_ctl,0xf000a814,1,rw
csr_register,spinor_delay_config,0xf0008004,1,rw
csr_register,btevents_ev_status,0xf0006000,1,rw
csr_register,keyboard_row3dat,0xf000880c,1,ro
csr_register,ctrl_scratch,0xf0000004,1,rw
csr_register,i2c_ev_enable,0xf0005820,1,rw
csr_register,spinor_delay_status,0xf0008008,1,ro
csr_register,i2c_ev_pending,0xf000581c,1,rw
csr_register,info_dna_id,0xf0003800,2,ro
csr_register,spinor_ev_enable,0xf0008020,1,rw
csr_register,com_ev_enable,0xf0005018,1,rw
csr_register,gpio_input,0xf0009004,1,ro
csr_register,keyboard_row4dat,0xf0008810,1,ro
csr_register,spinor_ecc_address,0xf0008024,1,ro
csr_register,crg_mmcm_drp_drdy,0xf0003010,1,ro
csr_register,audio_rx_stat,0xf000a810,1,ro
csr_register,romtest_address,0xf000a000,1,rw
csr_register,memlcd_command,0xf0004800,1,rw
csr_register,com_control,0xf0005008,1,rw
csr_register,memlcd_prescaler,0xf0004808,1,rw
csr_register,reboot_ctrl,0xf0002800,1,rw
csr_register,gpio_ev_enable,0xf000901c,1,rw
csr_register,spinor_config,0xf0008000,1,rw
csr_register,ctrl_bus_errors,0xf0000008,1,ro
csr_register,info_xadc_drp_adr,0xf0003854,1,rw
csr_register,timer0_ev_status,0xf0002014,1,rw
csr_register,info_platform_target,0xf0003824,2,ro
csr_register,crg_mmcm_drp_write,0xf000300c,1,rw
csr_register,ctrl_reset,0xf0000000,1,rw
csr_register,keyboard_row8dat,0xf0008820,1,ro
csr_register,uart_ev_pending,0xf0001810,1,rw
csr_register,crg_mmcm_drp_dat_r,0xf000301c,1,ro
csr_register,timer0_ev_enable,0xf000201c,1,rw
csr_register,info_xadc_drp_drdy,0xf0003850,1,ro
csr_register,ticktimer_control,0xf0007000,1,rw
csr_register,gpio_output,0xf0009000,1,rw
csr_register,keyboard_row5dat,0xf0008814,1,ro
csr_register,info_xadc_drp_read,0xf0003848,1,rw
csr_register,info_xadc_eoc,0xf000383c,1,ro
csr_register,uart_rxtx,0xf0001800,1,rw
csr_register,uart_rxempty,0xf0001808,1,ro
csr_register,spinor_ev_pending,0xf000801c,1,rw
csr_register,com_rx,0xf0005004,1,ro
csr_register,i2c_ev_status,0xf0005818,1,rw
csr_register,keyboard_ev_pending,0xf0008828,1,rw
csr_register,com_status,0xf000500c,1,ro
csr_register,info_xadc_vccbram,0xf0003838,1,ro
csr_register,i2c_status,0xf0005814,1,ro
csr_register,trng_osc_rand,0xf000b004,1,ro
csr_register,audio_rx_ctl,0xf000a80c,1,rw
csr_register,com_ev_pending,0xf0005014,1,rw
csr_register,timer0_en,0xf0002008,1,rw
csr_register,keyboard_ev_enable,0xf000882c,1,rw
csr_register,trng_osc_status,0xf000b008,1,ro
csr_register,power_power,0xf0007800,1,rw
csr_register,memlcd_ev_status,0xf000480c,1,rw
csr_register,keyboard_row2dat,0xf0008808,1,ro
csr_register,gpio_ev_status,0xf0009014,1,rw
csr_register,audio_ev_enable,0xf000a808,1,rw
csr_register,com_ev_status,0xf0005010,1,rw
csr_register,crg_mmcm_drp_dat_w,0xf0003018,1,rw
csr_register,memlcd_ev_pending,0xf0004810,1,rw
csr_register,crg_mmcm_drp_reset,0xf0003000,1,rw
csr_register,audio_ev_status,0xf000a800,1,rw
constant,config_cpu_type_vexriscv,None,,
constant,audio_interrupt,6,,
constant,timer0_interrupt,1,,
constant,config_csr_alignment,32,,
constant,config_csr_data_width,32,,
constant,gpio_interrupt,5,,
constant,config_cpu_reset_addr,0,,
constant,i2c_interrupt,2,,
constant,btevents_interrupt,3,,
constant,uart_interrupt,0,,
constant,config_clock_frequency,100000000,,
constant,keyboard_interrupt,4,,
constant,config_cpu_variant_standard,None,,
memory_region,sram_ext,0x40000000,16777216,cached
memory_region,sram,0x10000000,131072,cached
memory_region,memlcd,0xb0000000,23584,cached
memory_region,vexriscv_debug,0xefff0000,256,cached
memory_region,csr,0xf0000000,65536,io
memory_region,audio,0xe0000000,4,io
memory_region,rom,0x00000000,0,cached
memory_region,spiflash,0x20000000,134217728,cached
1 /home/bunnie/code/betrusted-soc/build/csr.csv #--------------------------------------------------------------------------------
1 #--------------------------------------------------------------------------------
2 # Auto-generated by Migen (e2e6c72) & LiteX (18a9d4f) on 2020-02-15 23:31:38
3 #--------------------------------------------------------------------------------
4 csr_base,sram_ext,0xf0004000,,
5 csr_base,ticktimer,0xf0007000,,
6 csr_base,messible,0xf0006800,,
7 csr_base,keyboard,0xf0008800,,
8 csr_base,power,0xf0007800,,
9 csr_base,info,0xf0003800,,
10 csr_base,reboot,0xf0002800,,
11 csr_base,timer0,0xf0002000,,
12 csr_base,uart_phy,0xf0001000,,
13 csr_base,gpio,0xf0009000,,
14 csr_base,trng_osc,0xf000b000,,
15 csr_base,seed,0xf0009800,,
16 csr_base,i2c,0xf0005800,,
17 csr_base,romtest,0xf000a000,,
18 csr_base,crg,0xf0003000,,
19 csr_base,btevents,0xf0006000,,
20 csr_base,spinor,0xf0008000,,
21 csr_base,audio,0xf000a800,,
22 csr_base,ctrl,0xf0000000,,
23 csr_base,uart,0xf0001800,,
24 csr_base,memlcd,0xf0005000,,
25 csr_base,com,0xf000c000,,
26 csr_register,i2c_prescale,0xf0005800,1,rw
27 csr_register,messible_in,0xf0006800,1,rw
28 csr_register,i2c_command,0xf0005810,1,rw
29 csr_register,btevents_ev_pending,0xf0006004,1,rw
30 csr_register,uart_ev_status,0xf000180c,1,rw
31 csr_register,i2c_txr,0xf0005808,1,rw
32 csr_register,info_xadc_drp_write,0xf000384c,1,rw
33 csr_register,info_platform_platform,0xf000381c,2,ro
34 csr_register,uart_phy_tuning_word,0xf0001000,1,rw
35 csr_register,keyboard_row1dat,0xf0008804,1,ro
36 csr_register,i2c_rxr,0xf000580c,1,ro
37 csr_register,keyboard_row6dat,0xf0008818,1,ro
38 csr_register,audio_tx_stat,0xf000a818,1,ro
39 csr_register,keyboard_rowchange,0xf0008830,1,ro
40 csr_register,info_xadc_drp_dat_w,0xf0003858,1,rw
41 csr_register,spinor_ecc_status,0xf0008028,1,ro
42 csr_register,uart_ev_enable,0xf0001814,1,rw
43 csr_register,audio_ev_pending,0xf000a804,1,rw
44 csr_register,messible_out,0xf0006804,1,ro
45 csr_register,keyboard_row0dat,0xf0008800,1,ro
46 csr_register,info_xadc_drp_dat_r,0xf000385c,1,ro
47 csr_register,info_xadc_vccint,0xf0003830,1,ro
48 csr_register,ticktimer_time,0xf0007004,2,ro
49 csr_register,keyboard_row7dat,0xf000881c,1,ro
50 csr_register,info_xadc_drp_enable,0xf0003844,1,rw
51 csr_register,spinor_command,0xf000800c,1,rw
52 csr_register,btevents_ev_enable,0xf0006008,1,rw
53 csr_register,timer0_ev_pending,0xf0002018,1,rw
54 csr_register,sram_ext_config_status,0xf0004000,1,ro
55 csr_register,timer0_reload,0xf0002004,1,rw
56 csr_register,timer0_load,0xf0002000,1,rw
57 csr_register,info_xadc_vccaux,0xf0003834,1,ro
58 csr_register,messible_status,0xf0006808,1,ro
59 csr_register,romtest_data,0xf000a004,1,ro
60 csr_register,memlcd_ev_enable,0xf0004814,1,rw
61 csr_register,i2c_control,0xf0005804,1,rw
62 csr_register,info_git_commit,0xf0003808,5,ro
63 csr_register,seed_seed,0xf0009800,2,ro
64 csr_register,info_xadc_temperature,0xf000382c,1,ro
65 csr_register,reboot_addr,0xf0002804,1,rw
66 csr_register,timer0_value,0xf0002010,1,ro
67 csr_register,crg_mmcm_drp_read,0xf0003008,1,rw
68 csr_register,crg_mmcm_drp_adr,0xf0003014,1,rw
69 csr_register,spinor_ev_status,0xf0008018,1,rw
70 csr_register,com_tx,0xf0005000,1,rw
71 csr_register,gpio_ev_pending,0xf0009018,1,rw
72 csr_register,crg_mmcm_drp_locked,0xf0003004,1,ro
73 csr_register,memlcd_Busy,0xf0004804,1,ro
74 csr_register,info_xadc_eos,0xf0003840,1,ro
75 csr_register,spinor_sector,0xf0008010,1,rw
76 csr_register,gpio_intena,0xf000900c,1,ro
77 csr_register,timer0_update_value,0xf000200c,1,rw
78 csr_register,gpio_drive,0xf0009008,1,rw
79 csr_register,uart_txfull,0xf0001804,1,ro
80 csr_register,trng_osc_ctl,0xf000b000,1,rw
81 csr_register,spinor_status,0xf0008014,1,ro
82 csr_register,sram_ext_read_config,0xf0004004,1,rw
83 csr_register,gpio_intpol,0xf0009010,1,ro
84 csr_register,keyboard_ev_status,0xf0008824,1,rw
85 csr_register,audio_tx_ctl,0xf000a814,1,rw
86 csr_register,spinor_delay_config,0xf0008004,1,rw
87 csr_register,btevents_ev_status,0xf0006000,1,rw
88 csr_register,keyboard_row3dat,0xf000880c,1,ro
89 csr_register,ctrl_scratch,0xf0000004,1,rw
90 csr_register,i2c_ev_enable,0xf0005820,1,rw
91 csr_register,spinor_delay_status,0xf0008008,1,ro
92 csr_register,i2c_ev_pending,0xf000581c,1,rw
93 csr_register,info_dna_id,0xf0003800,2,ro
94 csr_register,spinor_ev_enable,0xf0008020,1,rw
95 csr_register,com_ev_enable,0xf0005018,1,rw
96 csr_register,gpio_input,0xf0009004,1,ro
97 csr_register,keyboard_row4dat,0xf0008810,1,ro
98 csr_register,spinor_ecc_address,0xf0008024,1,ro
99 csr_register,crg_mmcm_drp_drdy,0xf0003010,1,ro
100 csr_register,audio_rx_stat,0xf000a810,1,ro
101 csr_register,romtest_address,0xf000a000,1,rw
102 csr_register,memlcd_command,0xf0004800,1,rw
103 csr_register,com_control,0xf0005008,1,rw
104 csr_register,memlcd_prescaler,0xf0004808,1,rw
105 csr_register,reboot_ctrl,0xf0002800,1,rw
106 csr_register,gpio_ev_enable,0xf000901c,1,rw
107 csr_register,spinor_config,0xf0008000,1,rw
108 csr_register,ctrl_bus_errors,0xf0000008,1,ro
109 csr_register,info_xadc_drp_adr,0xf0003854,1,rw
110 csr_register,timer0_ev_status,0xf0002014,1,rw
111 csr_register,info_platform_target,0xf0003824,2,ro
112 csr_register,crg_mmcm_drp_write,0xf000300c,1,rw
113 csr_register,ctrl_reset,0xf0000000,1,rw
114 csr_register,keyboard_row8dat,0xf0008820,1,ro
115 csr_register,uart_ev_pending,0xf0001810,1,rw
116 csr_register,crg_mmcm_drp_dat_r,0xf000301c,1,ro
117 csr_register,timer0_ev_enable,0xf000201c,1,rw
118 csr_register,info_xadc_drp_drdy,0xf0003850,1,ro
119 csr_register,ticktimer_control,0xf0007000,1,rw
120 csr_register,gpio_output,0xf0009000,1,rw
121 csr_register,keyboard_row5dat,0xf0008814,1,ro
122 csr_register,info_xadc_drp_read,0xf0003848,1,rw
123 csr_register,info_xadc_eoc,0xf000383c,1,ro
124 csr_register,uart_rxtx,0xf0001800,1,rw
125 csr_register,uart_rxempty,0xf0001808,1,ro
126 csr_register,spinor_ev_pending,0xf000801c,1,rw
127 csr_register,com_rx,0xf0005004,1,ro
128 csr_register,i2c_ev_status,0xf0005818,1,rw
129 csr_register,keyboard_ev_pending,0xf0008828,1,rw
130 csr_register,com_status,0xf000500c,1,ro
131 csr_register,info_xadc_vccbram,0xf0003838,1,ro
132 csr_register,i2c_status,0xf0005814,1,ro
133 csr_register,trng_osc_rand,0xf000b004,1,ro
134 csr_register,audio_rx_ctl,0xf000a80c,1,rw
135 csr_register,com_ev_pending,0xf0005014,1,rw
136 csr_register,timer0_en,0xf0002008,1,rw
137 csr_register,keyboard_ev_enable,0xf000882c,1,rw
138 csr_register,trng_osc_status,0xf000b008,1,ro
139 csr_register,power_power,0xf0007800,1,rw
140 csr_register,memlcd_ev_status,0xf000480c,1,rw
141 csr_register,keyboard_row2dat,0xf0008808,1,ro
142 csr_register,gpio_ev_status,0xf0009014,1,rw
143 csr_register,audio_ev_enable,0xf000a808,1,rw
144 csr_register,com_ev_status,0xf0005010,1,rw
145 csr_register,crg_mmcm_drp_dat_w,0xf0003018,1,rw
146 csr_register,memlcd_ev_pending,0xf0004810,1,rw
147 csr_register,crg_mmcm_drp_reset,0xf0003000,1,rw
148 csr_register,audio_ev_status,0xf000a800,1,rw
149 constant,config_cpu_type_vexriscv,None,,
150 constant,audio_interrupt,6,,
151 constant,timer0_interrupt,1,,
152 constant,config_csr_alignment,32,,
153 constant,config_csr_data_width,32,,
154 constant,gpio_interrupt,5,,
155 constant,config_cpu_reset_addr,0,,
156 constant,i2c_interrupt,2,,
157 constant,btevents_interrupt,3,,
158 constant,uart_interrupt,0,,
159 constant,config_clock_frequency,100000000,,
160 constant,keyboard_interrupt,4,,
161 constant,config_cpu_variant_standard,None,,
162 memory_region,sram_ext,0x40000000,16777216,cached
163 memory_region,sram,0x10000000,131072,cached
164 memory_region,memlcd,0xb0000000,23584,cached
165 memory_region,vexriscv_debug,0xefff0000,256,cached
166 memory_region,csr,0xf0000000,65536,io
167 memory_region,audio,0xe0000000,4,io
168 memory_region,rom,0x00000000,0,cached
169 memory_region,spiflash,0x20000000,134217728,cached

View file

@ -8,7 +8,9 @@ description = "Manage the video output"
[dependencies]
xous = { path = "../../xous-rs" }
embedded-graphics = "0.6"
utra = { path = "../../utra/utra"}
[target.'cfg(not(target_os = "none"))'.dependencies]
[target.'cfg(not(any(windows,unix)))'.dependencies]
utra = { path = "../../utra"}
[target.'cfg(any(windows,unix))'.dependencies]
minifb = "0.17"

View file

@ -9,4 +9,6 @@ description = "Shell test program"
bitflags = "1.2.1"
xous = { path = "../../xous-rs" }
graphics-server = { path = "../graphics-server" }
utra = { path = "../../utra/utra"}
[target.'cfg(not(any(windows,unix)))'.dependencies]
utra = { path = "../../utra"}

View file

@ -10,7 +10,9 @@ bitflags = "1.2.1"
xous-kernel = { package = "xous", path = "../xous-rs", features = ["forget-memory-messages"] }
stats_alloc = { version = "0.1.8", optional = true }
sha3 = { default-features = false, version = "0.8.2" }
utra = { path = "../utra/utra"}
[target.'cfg(not(any(windows, unix)))'.dependencies]
utra = { path = "../utra"}
[target.'cfg(target_arch = "riscv32")'.dependencies]
riscv = "0.5.6"

View file

@ -25,7 +25,6 @@ mod syscall;
use services::SystemServices;
use xous_kernel::*;
use utra;
#[cfg(baremetal)]
use core::panic::PanicInfo;

2
svd2utra/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
/target
Cargo.lock

10
svd2utra/Cargo.toml Normal file
View file

@ -0,0 +1,10 @@
[package]
name = "svd2utra"
version = "0.1.0"
authors = ["Sean Cross <sean@xobs.io>"]
edition = "2018"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
quick-xml = "0.19"

4742
svd2utra/examples/soc.svd Normal file

File diff suppressed because it is too large Load diff

630
svd2utra/src/generate.rs Normal file
View file

@ -0,0 +1,630 @@
use quick_xml::events::Event;
use quick_xml::Reader;
use std::io::{BufRead, BufReader, Read, Write};
#[derive(Debug)]
pub enum ParseError {
UnexpectedTag,
MissingValue,
ParseIntError,
NonUTF8,
}
#[derive(Default, Debug)]
struct Field {
name: String,
lsb: usize,
msb: usize,
}
#[derive(Default, Debug)]
struct Register {
name: String,
offset: usize,
description: Option<String>,
fields: Vec<Field>,
}
#[derive(Default, Debug)]
struct Peripheral {
name: String,
base: usize,
size: usize,
interrupt: Option<usize>,
registers: Vec<Register>,
}
#[derive(Default, Debug)]
struct MemoryRegion {
name: String,
base: usize,
size: usize,
}
#[derive(Default, Debug)]
struct Description {
peripherals: Vec<Peripheral>,
memory_regions: Vec<MemoryRegion>,
}
pub fn get_base(value: &str) -> (&str, u32) {
if value.starts_with("0x") {
(value.trim_start_matches("0x"), 16)
} else if value.starts_with("0X") {
(value.trim_start_matches("0X"), 16)
} else if value.starts_with("0b") {
(value.trim_start_matches("0b"), 2)
} else if value.starts_with("0B") {
(value.trim_start_matches("0B"), 2)
} else if value.starts_with('0') && value != "0" {
(value.trim_start_matches('0'), 8)
} else {
(value, 10)
}
}
fn parse_usize(value: &[u8]) -> Result<usize, ParseError> {
let value_as_str = String::from_utf8(value.to_vec()).or(Err(ParseError::NonUTF8))?;
let (value, base) = get_base(&value_as_str);
usize::from_str_radix(value, base).or(Err(ParseError::ParseIntError))
}
fn extract_contents<T: BufRead>(reader: &mut Reader<T>) -> Result<String, ParseError> {
let mut buf = Vec::new();
let contents = reader
.read_event(&mut buf)
.map_err(|_| ParseError::UnexpectedTag)?;
match contents {
Event::Text(t) => t
.unescape_and_decode(reader)
.map_err(|_| ParseError::NonUTF8),
_ => Err(ParseError::UnexpectedTag),
}
}
fn generate_field<T: BufRead>(reader: &mut Reader<T>) -> Result<Field, ParseError> {
let mut buf = Vec::new();
let mut name = None;
let mut lsb = None;
let mut msb = None;
loop {
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => {
let tag_name = e
.unescape_and_decode(reader)
.map_err(|_| ParseError::NonUTF8)?;
match tag_name.as_str() {
"name" => name = Some(extract_contents(reader)?),
"lsb" => lsb = Some(parse_usize(extract_contents(reader)?.as_bytes())?),
"msb" => msb = Some(parse_usize(extract_contents(reader)?.as_bytes())?),
_ => (),
}
}
Ok(Event::End(ref e)) => {
if let b"field" = e.name() {
break;
}
}
Ok(_) => (),
Err(e) => panic!("error parsing: {:?}", e),
}
}
Ok(Field {
name: name.ok_or(ParseError::MissingValue)?,
lsb: lsb.ok_or(ParseError::MissingValue)?,
msb: msb.ok_or(ParseError::MissingValue)?,
})
}
fn generate_fields<T: BufRead>(
reader: &mut Reader<T>,
fields: &mut Vec<Field>,
) -> Result<(), ParseError> {
let mut buf = Vec::new();
loop {
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => match e.name() {
b"field" => fields.push(generate_field(reader)?),
_ => panic!("unexpected tag in <field>: {:?}", e),
},
Ok(Event::End(ref e)) => match e.name() {
b"fields" => {
// println!("End fields");
break;
}
e => panic!("unhandled value: {:?}", e),
},
Ok(Event::Text(_)) => (),
e => panic!("unhandled value: {:?}", e),
}
}
Ok(())
}
fn generate_register<T: BufRead>(reader: &mut Reader<T>) -> Result<Register, ParseError> {
let mut buf = Vec::new();
let mut name = None;
let mut offset = None;
let description = None;
let mut fields = vec![];
loop {
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => {
let tag_name = e
.unescape_and_decode(reader)
.map_err(|_| ParseError::NonUTF8)?;
match tag_name.as_str() {
"name" => name = Some(extract_contents(reader)?),
"addressOffset" => {
offset = Some(parse_usize(extract_contents(reader)?.as_bytes())?)
}
"fields" => generate_fields(reader, &mut fields)?,
_ => (),
}
}
Ok(Event::End(ref e)) => {
if let b"register" = e.name() {
break;
}
}
Ok(_) => (),
Err(e) => panic!("error parsing: {:?}", e),
}
}
Ok(Register {
name: name.ok_or(ParseError::MissingValue)?,
offset: offset.ok_or(ParseError::MissingValue)?,
description,
fields,
})
}
fn generate_registers<T: BufRead>(
reader: &mut Reader<T>,
registers: &mut Vec<Register>,
) -> Result<(), ParseError> {
let mut buf = Vec::new();
loop {
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => match e.name() {
b"register" => registers.push(generate_register(reader)?),
_ => panic!("unexpected tag in <registers>: {:?}", e),
},
Ok(Event::End(ref e)) => match e.name() {
b"registers" => {
break;
}
e => panic!("unhandled value: {:?}", e),
},
Ok(Event::Text(_)) => (),
e => panic!("unhandled value: {:?}", e),
}
}
Ok(())
}
fn generate_peripheral<T: BufRead>(reader: &mut Reader<T>) -> Result<Peripheral, ParseError> {
let mut buf = Vec::new();
let mut name = None;
let mut base = None;
let mut size = None;
let mut registers = vec![];
loop {
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => {
let tag_name = e
.unescape_and_decode(reader)
.map_err(|_| ParseError::NonUTF8)?;
match tag_name.as_str() {
"name" => name = Some(extract_contents(reader)?),
"baseAddress" => {
base = Some(parse_usize(extract_contents(reader)?.as_bytes())?)
}
"size" => size = Some(parse_usize(extract_contents(reader)?.as_bytes())?),
"registers" => generate_registers(reader, &mut registers)?,
_ => (),
}
}
Ok(Event::End(ref e)) => {
if let b"peripheral" = e.name() {
break;
}
}
Ok(_) => (),
Err(e) => panic!("error parsing: {:?}", e),
}
}
Ok(Peripheral {
name: name.ok_or(ParseError::MissingValue)?,
base: base.ok_or(ParseError::MissingValue)?,
size: size.ok_or(ParseError::MissingValue)?,
interrupt: None,
registers,
})
}
fn generate_peripherals<T: BufRead>(reader: &mut Reader<T>) -> Result<Vec<Peripheral>, ParseError> {
let mut buf = Vec::new();
let mut peripherals = vec![];
loop {
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => match e.name() {
b"peripheral" => peripherals.push(generate_peripheral(reader)?),
_ => panic!("unexpected tag in <peripherals>: {:?}", e),
},
Ok(Event::End(ref e)) => match e.name() {
b"peripherals" => {
break;
}
e => panic!("unhandled value: {:?}", e),
},
Ok(Event::Text(_)) => (),
e => panic!("unhandled value: {:?}", e),
}
}
Ok(peripherals)
}
fn generate_memory_region<T: BufRead>(reader: &mut Reader<T>) -> Result<MemoryRegion, ParseError> {
let mut buf = Vec::new();
let mut name = None;
let mut base = None;
let mut size = None;
loop {
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => {
let tag_name = e
.unescape_and_decode(reader)
.map_err(|_| ParseError::NonUTF8)?;
match tag_name.as_str() {
"name" => name = Some(extract_contents(reader)?),
"baseAddress" => {
base = Some(parse_usize(extract_contents(reader)?.as_bytes())?)
}
"size" => size = Some(parse_usize(extract_contents(reader)?.as_bytes())?),
_ => (),
}
}
Ok(Event::End(ref e)) => {
if let b"memoryRegion" = e.name() {
break;
}
}
Ok(_) => (),
Err(e) => panic!("error parsing: {:?}", e),
}
}
Ok(MemoryRegion {
name: name.ok_or(ParseError::MissingValue)?,
base: base.ok_or(ParseError::MissingValue)?,
size: size.ok_or(ParseError::MissingValue)?,
})
}
fn parse_memory_regions<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::Start(ref e)) => match e.name() {
b"memoryRegion" => description
.memory_regions
.push(generate_memory_region(reader)?),
_ => panic!("unexpected tag in <memoryRegions>: {:?}", e),
},
Ok(Event::End(ref e)) => match e.name() {
b"memoryRegions" => {
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,
) -> Result<(), ParseError> {
let mut buf = Vec::new();
loop {
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => match e.name() {
b"memoryRegions" => parse_memory_regions(reader, description)?,
_ => panic!("unexpected tag in <vendorExtensions>: {:?}", e),
},
Ok(Event::End(ref e)) => match e.name() {
b"vendorExtensions" => {
break;
}
e => panic!("unhandled value: {:?}", e),
},
Ok(Event::Text(_)) => (),
e => panic!("unhandled value: {:?}", e),
}
}
Ok(())
}
fn print_header<U: Write>(out: &mut U) -> std::io::Result<()> {
let s = r####"
#![cfg_attr(target_os = "none", no_std)]
use core::convert::TryInto;
pub struct Register {
/// Offset of this register within this CSR
offset: usize,
}
impl Register {
pub const fn new(offset: usize) -> Register {
Register { offset }
}
}
pub struct Field {
/// A bitmask we use to AND to the value, unshifted.
/// E.g. for a width of `3` bits, this mask would be 0b111.
mask: usize,
/// Offset of the first bit in this field
offset: usize,
/// A copy of the register address that this field
/// is a member of. Ideally this is optimized out by the
/// compiler.
register: Register,
}
impl Field {
/// Define a new CSR field with the given width at a specified
/// offset from the start of the register.
pub const fn new(width: usize, offset: usize, register: Register) -> Field {
// Asserts don't work in const fn yet.
// assert!(width != 0, "field width cannot be 0");
// assert!((width + offset) < 32, "field with and offset must fit within a 32-bit value");
// It would be lovely if we could call `usize::pow()` in a const fn.
let mask = match width {
0 => 0,
1 => 1,
2 => 3,
3 => 7,
4 => 15,
5 => 31,
6 => 63,
7 => 127,
8 => 255,
9 => 511,
10 => 1023,
11 => 2047,
12 => 4095,
13 => 8191,
14 => 16383,
15 => 32767,
16 => 65535,
17 => 131071,
18 => 262143,
19 => 524287,
20 => 1048575,
21 => 2097151,
22 => 4194303,
23 => 8388607,
24 => 16777215,
25 => 33554431,
26 => 67108863,
27 => 134217727,
28 => 268435455,
29 => 536870911,
30 => 1073741823,
31 => 2147483647,
_ => 0,
};
Field {
mask,
offset,
register,
}
}
}
pub struct CSR<T> {
base: *mut T,
}
impl<T> CSR<T>
where
T: core::convert::TryFrom<usize> + core::convert::TryInto<usize> + core::default::Default,
{
pub fn new(base: *mut T) -> Self {
CSR { base }
}
/// Read the contents of this register
pub fn r(&mut self, reg: Register) -> T {
let usize_base: *mut usize = unsafe { core::mem::transmute(self.base) };
unsafe { usize_base.add(reg.offset).read_volatile() }
.try_into()
.unwrap_or_default()
}
/// Read a field from this CSR
pub fn rf(&mut self, field: Field) -> T {
let usize_base: *mut usize = unsafe { core::mem::transmute(self.base) };
((unsafe { usize_base.add(field.register.offset).read_volatile() } >> field.offset)
& field.mask)
.try_into()
.unwrap_or_default()
}
/// Read-modify-write a given field in this CSR
pub fn rmwf(&mut self, field: Field, value: T) {
let usize_base: *mut usize = unsafe { core::mem::transmute(self.base) };
let value_as_usize: usize = value.try_into().unwrap_or_default() << field.offset;
let previous =
unsafe { usize_base.add(field.register.offset).read_volatile() } & !field.mask;
unsafe {
usize_base
.add(field.register.offset)
.write_volatile(previous | value_as_usize)
};
}
/// Write a given field without reading it first
pub fn wfo(&mut self, field: Field, value: T) {
let usize_base: *mut usize = unsafe { core::mem::transmute(self.base) };
let value_as_usize: usize = (value.try_into().unwrap_or_default() & field.mask) << field.offset;
unsafe {
usize_base
.add(field.register.offset)
.write_volatile(value_as_usize)
};
}
/// Write the entire contents of a register without reading it first
pub fn wo(&mut self, reg: Register, value: T) {
let usize_base: *mut usize = unsafe { core::mem::transmute(self.base) };
let value_as_usize: usize = value.try_into().unwrap_or_default();
unsafe { usize_base.add(reg.offset).write_volatile(value_as_usize) };
}
/// Zero a field from a provided value
pub fn zf(&mut self, field: Field, value: T) -> T {
let value_as_usize: usize = value.try_into().unwrap_or_default();
(value_as_usize & !(field.mask << field.offset))
.try_into()
.unwrap_or_default()
}
/// Shift & mask a value to its final field position
pub fn ms(&mut self, field: Field, value: T) -> T {
let value_as_usize: usize = value.try_into().unwrap_or_default();
((value_as_usize & field.mask) << field.offset)
.try_into()
.unwrap_or_default()
}
}
"####;
out.write_all(s.as_bytes())
}
fn print_memory_regions<U: Write>(regions: &[MemoryRegion], out: &mut U) -> std::io::Result<()> {
writeln!(out, "// Physical base addresses of memory regions")?;
for region in regions {
writeln!(
out,
"pub const HW_{}_MEM: usize = 0x{:08x};",
region.name, region.base
)?;
writeln!(
out,
"pub const HW_{}_MEM_LEN: usize = {};",
region.name, region.size
)?;
}
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 {
writeln!(
out,
"pub const HW_{}_BASE : usize = {};",
peripheral.name.to_uppercase(), peripheral.base
)?;
}
writeln!(out)?;
writeln!(out, "pub mod utra {{")?;
for peripheral in peripherals {
writeln!(out)?;
writeln!(out, " pub mod {} {{", peripheral.name.to_lowercase())?;
for register in &peripheral.registers {
writeln!(out)?;
if let Some(description) = &register.description {
writeln!(out, " /// {}", description)?;
}
writeln!(
out,
" pub const {}: crate::Register = crate::Register::new({});",
register.name.to_uppercase(), register.offset
)?;
for field in &register.fields {
writeln!(
out,
" pub const {}_{}: crate::Field = crate::Field::new({}, {}, {});",
register.name,
field.name.to_uppercase(),
field.msb + 1 - field.lsb,
field.lsb,
register.name
)?;
}
}
writeln!(out, " }}")?;
}
writeln!(out, "}}")?;
Ok(())
}
fn print_tests<U: Write>(peripherals: &[Peripheral], out: &mut U) -> std::io::Result<()> {
let test_header = r####"
#[cfg(test)]
mod tests {
#[test]
#[ignore]
fn compile_check() {
use super::*;
"####.as_bytes();
out.write_all(test_header)?;
for peripheral in peripherals {
let mod_name = peripheral.name.to_lowercase();
let per_name = peripheral.name.to_uppercase();
for register in &peripheral.registers {
writeln!(out)?;
let reg_name = register.name.to_uppercase() + "_csr";
writeln!(out, " let mut {} = CSR::new(HW_{}_BASE as *mut u32);", reg_name, per_name)?;
writeln!(out, " let foo = {}.r(utra::{}::{});", reg_name, mod_name, reg_name)?;
writeln!(out, " {}.wo(utra::{}::{}, foo);", reg_name, mod_name, reg_name)?;
for field in &register.fields {
let field_name = format!("{}_{}", reg_name, field.name.to_uppercase());
writeln!(out, " let bar = {}.rf(utra::{}::{});", reg_name, mod_name, field_name)?;
writeln!(out, " {}.rmwf(utra::{}::{}, bar);", reg_name, mod_name, field_name)?;
writeln!(out, " let mut baz = {}.zf(utra::{}::{}, bar);", reg_name, mod_name, field_name)?;
writeln!(out, " baz |= {}.ms(utra::{}::{}, 1);", reg_name, mod_name, field_name)?;
writeln!(out, " {}.wfo(utra::{}::{}, baz);", reg_name, mod_name, field_name)?;
}
}
}
writeln!(out, " }}")?;
writeln!(out, "}}")?;
Ok(())
}
pub fn generate<T: Read, U: Write>(src: T, dest: &mut U) -> Result<(), ParseError> {
let mut buf = Vec::new();
let buf_reader = BufReader::new(src);
let mut reader = Reader::from_reader(buf_reader);
let mut description = Description::default();
loop {
match reader.read_event(&mut buf) {
Ok(Event::Start(ref e)) => match e.name() {
b"peripherals" => {
description.peripherals = generate_peripherals(&mut reader)?;
}
b"vendorExtensions" => {
parse_vendor_extensions(&mut reader, &mut description)?;
}
_ => (),
},
Ok(Event::Eof) => break,
Err(e) => panic!("Error at position {}: {:?}", reader.buffer_position(), e),
_ => (),
}
buf.clear();
}
print_header(dest).unwrap();
print_memory_regions(&description.memory_regions, dest).unwrap();
print_peripherals(&description.peripherals, dest).unwrap();
print_tests(&description.peripherals, dest).unwrap();
Ok(())
}

10
svd2utra/src/lib.rs Normal file
View file

@ -0,0 +1,10 @@
mod generate;
pub use generate::*;
#[cfg(test)]
mod tests {
#[test]
fn it_works() {
assert_eq!(2 + 2, 4);
}
}

10
svd2utra/src/main.rs Normal file
View file

@ -0,0 +1,10 @@
mod generate;
use generate::*;
use std::fs::File;
fn main() {
let src = File::open("examples/soc.svd").unwrap();
let mut dest = File::create("example.rs").unwrap();
generate(src, &mut dest).unwrap();
}