hw_regmap 0.2.2

hw_regmap: A register map generation tool.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# This is a sample example of register-map definition

module_name="Debug Offset"
description="Simple snippets to check the offset features"
word_size_b = 32
offset = 0x4000
range= 0x2000
# -> Register only between [0x4000 -> 0x6000 [
ext_pkg = []

# =====================================================================================================================
[section.Params]
description="Register that expose inner RTL parameters"
offset= 0x1000 # -> 0x5000
range=0x100
bytes_align=4
duplicate=["_dup1", "_dup2"]

[section.Params.register.ParamA]
  description="Parameter A"
  offset=0x20 # -> 0x5020
  owner="Parameter"
  read_access="Read"
  write_access="None"
  param_name="PARAM_A"

[section.Params.register.ParamB]
  description="Parameter B"
  offset=0x30 # -> 0x5030
  owner="Parameter"
  read_access="Read"
  write_access="None"
  param_name="PARAM_B"

# =====================================================================================================================
[section.FreeOffset]
description="Section with automatic offset computation"
bytes_align=32 # -> [0x5100; 0x5120]
duplicate=["_bank0","_bank1"]
[section.FreeOffset.register.test]
  description="Dummy addr register with automatic computation offset"
  owner="User"
  read_access="Read"
  write_access="Write"
  default={Cst=0x80}
  duplicate=["_msb", "_lsb"]

# =====================================================================================================================
[section.FixOffset]
description="Section with fixed offset"
offset=0x1800
bytes_align=8 # -> [0x5800; 0x5808]
duplicate=["_bank0","_bank1"]
[section.FixOffset.register.test]
  description="Dummy addr register with fixed offset"
  owner="User"
  read_access="Read"
  write_access="Write"
  default={Param="DFLT_ADDR"}
  duplicate=["_msb", "_lsb"]
# =====================================================================================================================