Using the doctree directive

Tip

To view the source of this document, click the “Show Source” option under the GitHub menu button on this page’s header.

The rdl:doctree directive is a convenient way to insert an entire peripheral’s register map documentation into a page.

Using the directive to target the “thingamabob” component…

.. rdl:doctree:: my_soc.thingamabob
    :link-to: doc

… produces the following output:

---

thingamabob

Path:

my_soc.thingamabob

Absolute Address:

0x1000

Offset	Identifier	Name
0x0	ctrl	-
0x4	status	-

ctrl

Path:

my_soc.thingamabob.ctrl

Absolute Address:

0x1000

Control register for the thingamabob peripheral

Bits	Identifier	Access	Reset	Name
[15:8]	bobbing_rate	rw	0xc	-
[1]	srst	w	0x0	-
[0]	en	rw	0x0	-

bobbing_rate

Rate (in Hz) that the thingamabob bobs.

Note

Setting the bobbing rate beyond 11 may cause the thingamabob to fail catastrophically.

srst

Soft reset.

This always reads as 0

status

Path:

my_soc.thingamabob.status

Absolute Address:

0x1004

Status register for the thingamabob.

If any critical failure is observed, do the following:

• Don’t panic.

• Issue a soft reset.

• Try turning it off and on.

• If the situation does not resolve, panic.

Bits	Identifier	Access	Reset	Name
[2]	idle	r	-	-
[1]	critical_bobbing_failure	r	-	-
[0]	critical_internal_fault	r	-	-