Skip to content

Commit 2aae0a0

Browse files
committed
Add reserved field best practice to doc
1 parent a4a7641 commit 2aae0a0

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

docs/best-practices.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,33 @@ With default assignments:
108108
something you didn't intend.
109109

110110
Avoid using default assignments in the root namespace.
111+
112+
113+
Do not define "reserved" fields in registers
114+
--------------------------------------------
115+
In SystemRDL, any gaps between fields are implicitly considered reserved space.
116+
There is no need to explicitly insert reserved fields - doing so is unnecessary
117+
work and only adds clutter to your design.
118+
119+
|:thumbsdown:| Bad:
120+
121+
.. code:: systemrdl
122+
123+
reg my_ctrl_reg {
124+
field {} RESERVED3[31:16];
125+
field {} mode[15:8];
126+
field {} RESERVED2[7:5];
127+
field {} rst[4:4];
128+
field {} RESERVED1[3:1];
129+
field {} en[0:0];
130+
};
131+
132+
|:thumbsup:| Good:
133+
134+
.. code:: systemrdl
135+
136+
reg my_ctrl_reg {
137+
field {} mode[15:8];
138+
field {} rst[4:4];
139+
field {} en[0:0];
140+
};

0 commit comments

Comments
 (0)