From 044892a7b3d43a2da2f88cc3b2053ab1f3619309 Mon Sep 17 00:00:00 2001 From: Stefan Frederik Date: Sat, 2 Jan 2021 22:18:46 +0100 Subject: [PATCH] documentation updates --- doc/xschem_man/commands.html | 2 +- doc/xschem_man/symbol_property_syntax.html | 41 ++++++++++++++++++++++ doc/xschem_man/xschem_properties.html | 6 ++-- src/keys.help | 2 +- 4 files changed, 46 insertions(+), 5 deletions(-) diff --git a/doc/xschem_man/commands.html b/doc/xschem_man/commands.html index d8a7db8c..69299c53 100644 --- a/doc/xschem_man/commands.html +++ b/doc/xschem_man/commands.html @@ -144,7 +144,7 @@ shift 'J' create xplot plot file for ngspice in simulation directo (just type xplot in ngspice) - 'j' Print list of highlighted nets/pins - 'k' Hilight selected nets -ctrl+shift 'K' highlight net passing through elements with 'propagate_to' property set on pins +ctrl+shift 'K' highlight net passing through elements with 'propag' property set on pins shift 'K' Unhilight all nets ctrl 'k' Unhilight selected nets alt 'k' Select all nets attached to selected wire / label / pin. diff --git a/doc/xschem_man/symbol_property_syntax.html b/doc/xschem_man/symbol_property_syntax.html index 0a3fcf0f..9fc046a2 100644 --- a/doc/xschem_man/symbol_property_syntax.html +++ b/doc/xschem_man/symbol_property_syntax.html @@ -46,6 +46,13 @@ p{padding: 15px 30px 10px;}
  • label: the symbol is used to label a net. These type of symbols must have one and only one pin, and the template string must define a lab attribute that is passed at component instantiationi to name the net it is attached to.
    • +
  • probe: this denotes a probe symbol that may be backannotated with a + backannotation script (example: ngspice_backannotate.tcl).
    • +
  • ngprobe: This is a probe element that uses a 'pull' method to fetch simulation + data and display it in current schematic. The data displayed is thus dynamic, multiple + instancs of the same symbol with annotators will display operating point data for that particular + instance without the need to update the backannotation as is required for annotators + using the 'push' annotation methid.
  • netlist_commands: the symbol is used to place SPICE commands into a spice netlist. It should also have a value attribute that may contain arbitrary text that is copied verbatim into the netlist. More on this in the netlist slide.
    • @@ -286,6 +293,40 @@ m5 net1 b net2 VSSPIN nlv w=wn l=ln geomod=0 m=1 Defines the direction of a symbol pin. Allowed values are in, out, inout.

    +
  • propag=n
    • +

    + This attribute instructs xschem to do a 'propagate highlight' from the pin with this attribute to the + pin n. The number 'n' refers to the pin sequence number (do a shift-S after + selecting destination pin to know this information). +

    +
  • goto=n[,m,...]
    • +

    + This attribute is used in the xschem embedded digital simulation engine: propagate logic simulation + to the output pins n,[m,...]. The logic function is defined via the 'functionn' + global attribute. There is one 'funtionn' for each n output pin. + see 'functionn' attribute for more info. +

    + + +
  • clock=n
    • +

    + A clock attribute defined on input pins add some information on the pin function as follows: +

    +

    +
  • function
    • +

    + This attribute is set in the symbol global attributes and specifies the logic function to be applied + to the associated output pin. The format is: function<n>="...logic function..." + where the number <n> refers to the sequence number of the output pin (do a 'Shift-S' + after selecting the pin to know its sequence number). Multiple functions (function3="...", function4="...") + can be defined in case of elements with multiple outputs. +

    +
  • global

    • a global=true property in a label type symbol will declare the corresponding net as 'global'. diff --git a/doc/xschem_man/xschem_properties.html b/doc/xschem_man/xschem_properties.html index 092533d7..50b15f79 100644 --- a/doc/xschem_man/xschem_properties.html +++ b/doc/xschem_man/xschem_properties.html @@ -43,13 +43,13 @@ p{padding: 15px 30px 10px;}

    - The name=p dir=inout propagate_to=1 pinnumber=1 property string tells that the + The name=p dir=inout propag=1 pinnumber=1 property string tells that the selected pin name is 'p', this will be the symbol positive pin name in the produced netlist. The property string also defines a dir attribute with value inout. This tells XSCHEM that electrically this is an input/output pin. This is important when producing VHDL/verilog netlists. - The propagate_to=1 tells XSCHEM that when we select a wire attaced to this pin + The propag=1 tells XSCHEM that when we select a wire attaced to this pin (which is located at index 0 in xschem) the highlight will propagate to the other pin (with index 1). To view the xschem index of a pin click and hold the mouse on it, the index will be shown as n= <number> in the bottom status line: @@ -58,7 +58,7 @@ p{padding: 15px 30px 10px;}

    The pinnumber=1 attribute is used when exporting to pcb software (via the tEDAx netlist) and tells to which pin number on the resistor footprint this positive pin is bound. - The second (bottom) pin property string is name=m dir=inout propagate_to=0 pinnumber=2 and this + The second (bottom) pin property string is name=m dir=inout propag=0 pinnumber=2 and this defines the negative pin. The text primitives also have properties. For texts the property string may be used to specify font and the layer to use for displaying text. diff --git a/src/keys.help b/src/keys.help index fe04d7bc..32414e72 100644 --- a/src/keys.help +++ b/src/keys.help @@ -103,7 +103,7 @@ shift 'J' create xplot plot file for ngspice in simulation directo (just type xplot in ngspice) - 'j' Print list of highlighted nets/pins - 'k' Hilight selected nets -ctrl+shift 'K' highlight net passing through elements with 'propagate_to' property set on pins +ctrl+shift 'K' highlight net passing through elements with 'propag' property set on pins shift 'K' Unhilight all nets ctrl 'k' Unhilight selected nets alt 'k' Select all nets attached to selected wire / label / pin.