diff --git a/doc/xschem_man/component_property_syntax.html b/doc/xschem_man/component_property_syntax.html index 528a1b02..7c3948c0 100644 --- a/doc/xschem_man/component_property_syntax.html +++ b/doc/xschem_man/component_property_syntax.html @@ -144,6 +144,35 @@ name="mchanged_name" model=\"nmos\" w="20u" l="3u" m="10"
This tells XSCHEM that for Verilog netlist this component will be completely ignored.
This tells XSCHEM that for VHDL netlist this component will be completely ignored.
+ + + If any of these attributes are present and not empty and the symbol type is set to subcircuit
+ the corresponding netlister will ignore the schematic subcircuit for this specific instance
+ and dump into the netlist the content of this attribute.
+ This attribute must be paired with a schematic=... attribute set on the instance that tells
+ the subcircuit name to use for this particular instance.
+ The typical usage is to include a file, example:
+
+ verilog_sym_def="tcleval(`include \"[abs_sym_path verilog_include_file.v]\")" ++ +
+ In this example a verilog_include_file.v is included using the verilog `include directive.
+ In order to generate a full path for it the abs_sym_path TCL function is used that searches for this file
+ in any of the XCHEM_LIBRARY_PATH directories. Since TCL is used the attribute is wrappend into a tcleval(...),
+ The following will appear in the generated netlist:
+
+// expanding symbol: verilog_include.sym # of pins=3 +// sym_path: /home/schippes/.xschem/xschem_library/verilog_include.sym +`include "/home/schippes/.xschem/xschem_library/verilog_include_file.v" ++ + + +
For VHDL type netlist, this tells that the current label names a signal (or constant) of
type sig_type. For example a label can be placed with name TEST and
@@ -185,7 +214,7 @@ name="mchanged_name" model=\"nmos\" w="20u" l="3u" m="10"
instance of a given subcircuit.
The specified schematic must have the same interface (in/out/inout pins) as the base schematic (that
is inferred from the symbol name).
- Example: schematic=sky130_tests/inv2.sym
+ Example: schematic=sky130_tests/inv2.sch