luke
/
xschem
mirror of https://github.com/StefanSchippers/xschem.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc updates (@spice_get_node)

This commit is contained in:
stefan schippers 2025-01-11 01:34:41 +01:00
parent 69ddd2966c
commit 9d54269d25
2 changed files with 50 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/xschem_man/symbol_property_syntax.html
View File

@ -568,7 +568,10 @@ verilog_format="xnor #(@risedel , @falldel ) @name ( @@Z , @@A , @@B );"
<p> This expands to the net that connect to symbol pin named <kbd>pin</kbd>. This substitution
takes place only when producing a netlist (Spice, Verilog, VHDL, tEDAx) so it is allowed to use this
value only in <kbd>format</kbd>,<kbd>vhdl_format</kbd>, <kbd>tedax_format</kbd> or <kbd>verilog_format</kbd>
attributes (see <a href="netlisting.html">Netlisting slide)</a></p>
attributes (see <a href="netlisting.html">Netlisting slide)</a><br>
The @#pin attribute is expanded to <kbd>?m net</kbd> where <kbd>m</kbd> is the pin multiplicity and
<kbd>net</kbd> is the name of the net attached to the symbol <kbd>pin</kbd>. This information is needed
by the xschem netlister.</p>
<li><kbd>@#n</kbd></li>
<p>
This expands to the net that connect to symbol pin at position <kbd>n</kbd> in the XSCHEM internal storage. This substitution
@ -577,6 +580,10 @@ verilog_format="xnor #(@risedel , @falldel ) @name ( @@Z , @@A , @@B );"
attributes (see <a href="netlisting.html">Netlisting slide)</a><br>
This method of accessing a net that connects to a pin is much faster than previous one since XSCHEM does not need to
loop through symbol pin names looking for a match.<br>
The @#n attribute is expanded to <kbd>?m net</kbd> where <kbd>m</kbd> is the <kbd>n-th</kbd> pin multiplicity and
<kbd>net</kbd> is the name of the net attached to the symbol <kbd>cwn-thpin</kbd> pin. This information is needed
by the xschem netlister.</p>
Example: <kbd>@#2</kbd>: return net name that connects to the third pin of the symbol (position 2).
</p>
<li><kbd>@#n:pin_attribute</kbd></li>
@ -612,6 +619,27 @@ verilog_format="xnor #(@risedel , @falldel ) @name ( @@Z , @@A , @@B );"
sequence number <kbd>n</kbd>, extracted from simulation raw file (operating point or
cursor <kbd>b</kbd> position)</p>
<li><kbd>@spice_get_node spice_node </kbd></li>
<p>
<kbd>spice_node</kbd> Will be replaced with the Spice simulated value for that node.<br>
Examples:<br>
<kbd>Id=@spice_get_node i(\@m.@path@spiceprefix@name\.msky130_fd_pr__@model\[id])</kbd><br>
will translate to: <br>
<kbd>Id=6.6177u</kbd><br>
and:<br>
<kbd>Id=@spice_get_node i(\@m.@path@spiceprefix@name\.msky130_fd_pr__@model\[id]) A</kbd><br>
will translate to: <br>
<kbd>Id=6.6177uA</kbd><br>
note the required separator spaces around the spice node. Spaces are used here as
separators since spice nodes don't allow spaces.
escapes are used for 2 reasons:
mark a @ as a literal character instead of a the start of a @var token to be substituted
mark the end of a @var, like for example @var\iable. In this case @var will
be substituted by xschem instead of @variable.<br>
Caveats: only one @spice_get_node is allowed in a string for now.
</p>
<li><kbd>@sch_last_modified</kbd></li>
<p>
this indicates the last modification time of the <kbd>.sch</kbd> file of the symbol.

21
src/token.c
View File

@ -3646,6 +3646,27 @@ static char *get_pin_attr(const char *token, int inst, int engineering)
return value;
}
/* This routine processes the entire string returned by translate, looks
* for "@spice_get_node <spice_node> " patterns and replaces with the
* Spice simulated value for that node.
* the format is "some_text@spice_get_node <spice_node> some_additional_text"
* Examples:
* Id=@spice_get_node i(\@m.@path@spiceprefix@name\.msky130_fd_pr__@model\[id])
* will translate to:
* Id=6.6177u
* Id=@spice_get_node i(\@m.@path@spiceprefix@name\.msky130_fd_pr__@model\[id]) A
* will translate to:
* Id=6.6177uA
* note the required separator spaces around the spice node. Spaces are used here as
* separators since spice nodes don't allow spaces.
* escapes are used for 2 reasons:
* mark a @ as a literal character instead of a the start of a @var token to be substituted
* mark the end of a @var, like for example @var\iable. In this case @var will
* be substituted by xschem instead of @variable
*
* caveats: only one @spice_get_node is allowed in a string for now.
*/
const char *spice_get_node(const char *token)
{
const char *pos;