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
63

# This is a sample example of register-map definition

module_name="debug_default"
description="Simple register configuration to check default value"
word_size_b = 32
offset = 0x00
range = 0x40
ext_pkg = []

# =====================================================================================================================
[section.Params]
description="Contain parameters with field and default value based on parameters"
offset= 0x10
align_offset=true

[section.Params.register.NoField]
  description="Register without field"
  owner="Parameter"
  read_access="Read"
  write_access="None"
  default={Param="NO_FIELD_PARAMS"}

[section.Params.register.WithFieldParams]
  description="Register with Fields and params default"
  owner="Parameter"
  read_access="Read"
  write_access="None"
  field.sub_a = { size_b=8, offset_b=0 , default={Param="SUB_A"}, description="Subfield A"}
  field.sub_b = { size_b=8, offset_b=8 , default={Param="SUB_B"}, description="Subfield B"}
  field.sub_c = { size_b=8, offset_b=16, default={Param="SUB_C"}, description="Subfield C"}
  field.sub_d = { size_b=8, offset_b=24, default={Param="SUB_D"}, description="Subfield D"}

[section.Params.register.WithFieldCst]
  description="Register with Fields and constant default"
  owner="Parameter"
  read_access="Read"
  write_access="None"
  field.sub_a = { size_b=8, offset_b=0 , default={Cst=0x1}, description="Subfield A"}
  field.sub_b = { size_b=8, offset_b=8 , default={Cst=0x2}, description="Subfield B"}
  field.sub_c = { size_b=8, offset_b=16, default={Cst=0x3}, description="Subfield C"}
  field.sub_d = { size_b=8, offset_b=24, default={Cst=0x4}, description="Subfield D"}

[section.Params.register.WithFieldMixed]
  description="Register with Fields and mixed default"
  owner="Parameter"
  read_access="Read"
  write_access="None"
  field.sub_a = { size_b=8, offset_b=0 , default={Param="SUB_A"}, description="Subfield A"}
  field.sub_b = { size_b=8, offset_b=8 , default={Cst=0x2}, description="Subfield B"}
  field.sub_c = { size_b=8, offset_b=16, default={Param="SUB_C"}, description="Subfield C"}
  field.sub_d = { size_b=8, offset_b=24, default={Cst=0x4}, description="Subfield D"}

[section.Params.register.WithFieldGlobal]
  description="Register with Fields and global default"
  owner="Parameter"
  read_access="Read"
  write_access="None"
  default = {Param="WITH_FIELD_GLOBAL"}
  field.sub_a = { size_b=8, offset_b=0 , description="Subfield A"}
  field.sub_b = { size_b=8, offset_b=8 , description="Subfield B"}
  field.sub_c = { size_b=8, offset_b=16, description="Subfield C"}
  field.sub_d = { size_b=8, offset_b=24, description="Subfield D"}