Overview
Register File.
TODO: example
Classes:
| Name | Description |
|---|---|
Field |
Field. |
Word |
Word. |
Words |
Set of Words. |
Addrspace |
Address Space. |
SigExprTuple |
Used for Guard Management. |
GrdSlcTuple |
Used for Guard Management. |
UcdpRegfMod |
Register File. |
FieldIoType |
Field IO Type. |
Functions:
| Name | Description |
|---|---|
get_in_regf |
Calculate whether field is in regf. |
check_field |
Check for Corner Cases On Field. |
filter_busacc |
Bus accessible Fields. |
filter_regf_flipflops |
In-Regf Flop Fields. |
filter_regf_consts |
In-Regf Constant Fields. |
filter_buswrite |
Writable Bus Fields. |
filter_buswriteonce |
Write-Once Bus Fields. |
filter_busread |
Bus-Readable Fields. |
filter_busrdmod |
Modify-on-read Fields in Regf. |
filter_busgrderr |
Fields with conditional Modify Access. |
filter_coreacc |
Core-Accessible Fields. |
filter_coreread |
Core-Readable Fields. |
filter_incore_buswr |
Bus-written in-core fields. |
get_regfiotype |
Determine IO-Type for fields in |
get_regfwordiotype |
Determine IO-Type for words in |
get_regfportname |
Determine Name of Portname. |
Bases: Field
Field.
Methods:
| Name | Description |
|---|---|
from_word |
Create Field Containing Word. |
Attributes:
| Name | Type | Description |
|---|---|---|
portgroups |
tuple[str, ...] | None
|
Portgroups. |
in_regf |
bool
|
Implementation within Regf. |
upd_prio |
Prio | None
|
Update Priority: None, 'b'us or 'c'core. |
upd_strb |
bool
|
Update strobe towards core. |
upd_grps |
tuple[str, ...] | None
|
Update strobe portgroups. |
wr_guard |
str | None
|
Write guard name (must be unique). |
guard_err |
GrdErrMode
|
Bus error on write to guarded/write-once field. |
signame |
str
|
Signal Basename to Core. |
route |
Routeables | None
|
Optional Route. |
is_alias |
bool
|
Used as Alias for Wordio. |
bus_prio |
bool
|
Update prioriy for bus. |
valname |
str
|
Reference to Current Value. |
corewrname |
str
|
Reference to Value towards Core. |
class-attribute
instance-attribute
Update Priority: None, 'b'us or 'c'core.
class-attribute
instance-attribute
Bus error on write to guarded/write-once field.
Bases: Word
Word.
Attributes:
| Name | Type | Description |
|---|---|---|
portgroups |
tuple[str, ...] | None
|
Default Portgroups for Fields. |
in_regf |
bool | None
|
Default Implementation within Regf. |
upd_prio |
Prio | None
|
Update Priority: None, 'b'us or 'c'core. |
upd_strb |
WordStrb
|
Update strobe towards core. |
upd_grps |
tuple[str, ...] | None
|
Update strobe portgroups. |
wr_guard |
str | None
|
Write guard name (must be unique). |
guard_err |
GrdErrMode
|
Bus error on write to word with guarded/write-once fields. |
wordio |
bool
|
Create Word-Based Interface Towards Core. |
fieldio |
bool
|
Create Field-Based Interface Towards Core. |
class-attribute
instance-attribute
Update Priority: None, 'b'us or 'c'core.
class-attribute
instance-attribute
Bus error on write to word with guarded/write-once fields.
Bases: Words
Set of Words.
Bases: Addrspace
Address Space.
Attributes:
| Name | Type | Description |
|---|---|---|
portgroups |
tuple[str, ...] | None
|
Default Portgroups for Words. |
in_regf |
bool | None
|
Default Implementation within Regf. |
upd_prio |
Prio | None
|
Update Priority: None, 'bus' or 'core'. |
upd_strb |
bool
|
Update strobe towards core. |
upd_grps |
tuple[str, ...] | None
|
Update strobe portgroups. |
wr_guard |
str | None
|
Write guard name (must be unique). |
guard_err |
GrdErrMode
|
Bus error on write to words with guarded/write-once fields. |
addr_width |
int
|
Returns derived Address Width for Addrspace. |
class-attribute
instance-attribute
Bus error on write to words with guarded/write-once fields.
Bases: ATailoredMod
Register File.
Methods:
| Name | Description |
|---|---|
add_word |
Add Word. |
add_words |
Add Words. |
add_soft_rst |
Add Soft Reset. |
get_overview |
Overview. |
get_addrspaces |
Yield Address Space. |
Attributes:
| Name | Type | Description |
|---|---|---|
width |
int
|
Width in Bits. |
depth |
int
|
Number of words. |
slicing |
PositiveInt | SliceWidths | None
|
Use sliced write enables (of same or individual widths). |
portgroups |
tuple[str, ...] | None
|
Default Portgroups for Words. |
in_regf |
bool | None
|
Default Implementation within Regf. |
upd_prio |
Prio | None
|
Update Priority: None, 'bus' or 'core'. |
upd_strb |
bool
|
Update strobe towards core. |
wr_guard |
str | None
|
Write guard name (must be unique). |
guard_err |
GrdErrMode
|
Bus error on write to words with guarded/write-once fields. |
addrspace |
Addrspace
|
Address Space. |
regfiotype |
DynamicStructType
|
IO-Type With All Field-Wise Core Signals . |
regfwordiotype |
DynamicStructType
|
IO-Type With All Word-Wise Core Signals . |
memiotype |
MemIoType
|
Memory IO-Type. |
class-attribute
instance-attribute
Use sliced write enables (of same or individual widths).
class-attribute
instance-attribute
Bus error on write to words with guarded/write-once fields.
Add Soft Reset.
Calling w/o argument results in adding input 'soft_rst_i.
Calling with a string will be treated as soft reset input port name and checked for name and type conformance.
calling with a string '
Bases: DynamicStructType
Field IO Type.
Determine IO-Type for fields in addrspace.
Determine IO-Type for words in addrspace.