From: Clifford Wolf <clifford@clifford.at>
Date: Fri, 22 Aug 2014 12:37:14 +0000 (+0200)
Subject: Added DPI-C documentation to README file
X-Git-Tag: yosys-0.4~217
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=ba83a7bdc641c68344b41f407323c76b8c62c674;p=yosys.git

Added DPI-C documentation to README file
---

diff --git a/README b/README
index 5c3286c20..2e713ffef 100644
--- a/README
+++ b/README
@@ -317,6 +317,18 @@ Verilog Attributes and non-standard features
         ...
       endmodule
 
+- A limited subset of DPI-C functions is supported. The plugin mechanism
+  (see "help plugin") can be used load .so files with implementations of
+  DPI-C routines. As a non-standard extension it is possible to specify
+  a plugin alias using the "<alias>:" syntax. for example:
+
+      module dpitest;
+        import "DPI-C" function foo:round = real my_round (real);
+        parameter real r = my_round(12.345);
+      endmodule
+
+      $ yosys -p 'plugin -a foo -i /lib/libm.so; read_verilog dpitest.v'
+
 - Sized constants (the syntax <size>'s?[bodh]<value>) support constant
   expressions as <size>. If the expresion is not a simple identifier, it
   must be put in parentheses. Examples: WIDTH'd42, (4+2)'b101010