aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJeff Wang <jjj11x@gmail.com>2020-02-17 04:40:18 -0500
committerJeff Wang <jeff.wang@utexas.edu>2020-02-17 04:42:55 -0500
commit1c16311d104caa19e8aff35a0df1595c73fa1638 (patch)
tree3d05fed123b570284089343cf04f6b96a6f65675
parenta31ba8e5d5b5eefdea35aaec585118dca6287673 (diff)
downloadyosys-1c16311d104caa19e8aff35a0df1595c73fa1638.tar.gz
yosys-1c16311d104caa19e8aff35a0df1595c73fa1638.tar.bz2
yosys-1c16311d104caa19e8aff35a0df1595c73fa1638.zip
update documentation for enums and typedefs
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 77e9410da..696a4d0b1 100644
--- a/README.md
+++ b/README.md
@@ -437,6 +437,17 @@ Verilog Attributes and non-standard features
...
endmodule
+- The ``wiretype`` attribute is added by the verilog parser for wires of a
+ typedef'd type to indicate the type identifier.
+
+- Various ``enum_{width}_{value}`` attributes are added to wires of an
+ enumerated type to give a map of possible enum items to their values.
+
+- The ``enum_base_type`` attribute is added to enum items to indicate which
+ enum they belong to (enums -- anonymous and otherwise -- are
+ automatically named with an auto-incrementing counter). Note that enums
+ are currently not strongly typed.
+
- A limited subset of DPI-C functions is supported. The plugin mechanism
(see ``help plugin``) can be used to load .so files with implementations
of DPI-C routines. As a non-standard extension it is possible to specify
@@ -527,6 +538,12 @@ from SystemVerilog:
SystemVerilog files being read into the same design afterwards.
- typedefs are supported (including inside packages)
+ - type identifiers must currently be enclosed in (parentheses) when declaring
+ signals of that type (this is syntactically incorrect SystemVerilog)
+ - type casts are currently not supported
+
+- enums are supported (including inside packages)
+ - but are currently not strongly typed
- SystemVerilog interfaces (SVIs) are supported. Modports for specifying whether
ports are inputs or outputs are supported.