d2b4911d5f
* declared intwidth, fracwidth, and is_signed UDPs * fix boolean type name in UDP definition * generate hwif fields with fixedpoint indices * make "counter" and "encode" properties mutualy exclusive with signed/fixedpoint * add signed/unsigned to hwif * improved fixedpoint error messages, added validation tests * added fixedpoint tests * fixedpoint/signed not allowed for signal components * added signed/fixedpoint UDP docs * handle single-bit fixedpoint numbers * fix too many positional arguments lint * changed spelling of fixedpoint to fixed-point * use "logic" in place of "unsigned logic" * split signed and fixedpoint docs, added examples * allow enums with is_signed=false * split signed and fixedpoint implementations * assorted nits picked * updated is_signed validation unit test
86 lines
2.1 KiB
ReStructuredText
86 lines
2.1 KiB
ReStructuredText
Introduction
|
|
============
|
|
|
|
Although the official SystemRDL spec defines numerous properties that allow you
|
|
to define complex register map structures, sometimes they are not enough to
|
|
accurately describe a necessary feature. Fortunately the SystemRDL spec allows
|
|
the language to be extended using "User Defined Properties" (UDPs). The
|
|
PeakRDL-regblock tool understands several UDPs that are described in this
|
|
section.
|
|
|
|
To enable these UDPs, compile this RDL file prior to the rest of your design:
|
|
:download:`regblock_udps.rdl <../../hdl-src/regblock_udps.rdl>`.
|
|
|
|
.. list-table:: Summary of UDPs
|
|
:header-rows: 1
|
|
|
|
* - Name
|
|
- Component
|
|
- Type
|
|
- Description
|
|
|
|
* - buffer_reads
|
|
- reg
|
|
- boolean
|
|
- If set, reads from the register are double-buffered.
|
|
|
|
See: :ref:`read_buffering`.
|
|
|
|
* - rbuffer_trigger
|
|
- reg
|
|
- reference
|
|
- Defines the buffered read load trigger.
|
|
|
|
See: :ref:`read_buffering`.
|
|
|
|
* - buffer_writes
|
|
- reg
|
|
- boolean
|
|
- If set, writes to the register are double-buffered.
|
|
|
|
See: :ref:`write_buffering`.
|
|
|
|
* - wbuffer_trigger
|
|
- reg
|
|
- reference
|
|
- Defines the buffered write commit trigger.
|
|
|
|
See: :ref:`write_buffering`.
|
|
|
|
* - rd_swacc
|
|
- field
|
|
- boolean
|
|
- Enables an output strobe that is asserted on sw reads.
|
|
|
|
See: :ref:`extended_swacc`.
|
|
|
|
* - wr_swacc
|
|
- field
|
|
- boolean
|
|
- Enables an output strobe that is asserted on sw writes.
|
|
|
|
See: :ref:`extended_swacc`.
|
|
|
|
* - is_signed
|
|
- field
|
|
- boolean
|
|
- Defines the signedness of a field.
|
|
|
|
See: :ref:`signed`.
|
|
|
|
* - intwidth
|
|
- field
|
|
- unsigned integer
|
|
- Defines the number of integer bits in the fixed-point representation
|
|
of a field.
|
|
|
|
See: :ref:`fixedpoint`.
|
|
|
|
* - fracwidth
|
|
- field
|
|
- unsigned integer
|
|
- Defines the number of fractional bits in the fixed-point representation
|
|
of a field.
|
|
|
|
See: :ref:`fixedpoint`.
|