the good old mans
This commit is contained in:
Christophe Alexandre
parent
bc26af71d0
commit
9322e68443
|
|
@ -43,4 +43,6 @@ AC_OUTPUT([
|
|||
Makefile
|
||||
src/Makefile
|
||||
doc/Makefile
|
||||
doc/man1/Makefile
|
||||
doc/man3/Makefile
|
||||
])
|
||||
|
|
|
|||
|
|
@ -1,4 +1 @@
|
|||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
man_MANS = genpat.1
|
||||
EXTRA_DIST = $(man_MANS)
|
||||
SUBDIRS = man1 man3
|
||||
|
|
|
|||
|
|
@ -0,0 +1,4 @@
|
|||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
man_MANS = genpat.1
|
||||
EXTRA_DIST = $(man_MANS)
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.\" $Id: genpat.1,v 1.1 2002/05/30 13:28:15 xtof Exp $
|
||||
.\" $Id: genpat.1,v 1.1 2002/05/31 08:27:42 xtof Exp $
|
||||
.\" @(#)genpat 2.0 Sep 07 1993 UPMC; Author: PITON D.
|
||||
.TH GENPAT 1 "October 1, 1997" "ASIM/LIP6" "ALLIANCE USER COMMANDS"
|
||||
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
.\" $Id: AFFECT.3,v 1.1 2002/05/31 08:27:45 xtof Exp $
|
||||
.\" @(#)AFFECT.3 2.30 Sep 08 1993 UPMC ; VUONG H.N. & PITON D.
|
||||
.TH AFFECT 3 "October 1, 1997" "ASIM/LIP6" "GENPAT functions"
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
\fBAFFECT\fP, GENPAT Package
|
||||
|
||||
.so man1/alc_origin.1
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
.nf
|
||||
AFFECT ("pattern_date", "ident", "value");
|
||||
.fi
|
||||
|
||||
.SH PARAMETERS
|
||||
.PP
|
||||
.TP 10
|
||||
\fIpattern_date\fP
|
||||
: pattern date which may be either : integer (absolute date) or + integer
|
||||
(relative date, the date of the current pattern (last modified using INIT
|
||||
or AFFECT) is the reference). All dates are supposed to be expressed in
|
||||
the same time unit which may be set only once using SETTUNIT.
|
||||
.TP 10
|
||||
\fIident\fP
|
||||
Either the name of a bused signal or a scalar. Vectors must be referenced with
|
||||
their names only, or bit per bit. For example, if b(3 downto 0) exists, you
|
||||
can affect "b", "b(3)" or "b 3".
|
||||
.TP 10
|
||||
\fIvalue\fP
|
||||
The value associated with the signal which may be either a based number
|
||||
(ex. binary: 0b011 ,hexa: 0x3F, octal: 0o56) or a decimal number. Unknown
|
||||
value (value where a '*' appears), can be used when dealing with an output,
|
||||
a signal, a register or an input/output when this last one is to be tested.
|
||||
Star ('*') can appears everywhere in a BASED number, but the result will be a
|
||||
"full star" value. (For example, "0B0*10" and "0B***" would give the same
|
||||
result.) AFFECT is doing automatically the transformation of the value into
|
||||
a "forced" value or a "tested" value except for the bidirectional connectors
|
||||
affectation. When and bidirectional is to be tested, a '?' character must be
|
||||
added before the value (example : "?0x45f*" instead of "0x45f*").
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
"Affect" a value to a signal. This value will be apllied to the signal, at
|
||||
the specified simulation date, until the end of the simulation or until a new
|
||||
value is affected to the signal. Beware : Inputs have to be affected at the
|
||||
begining of the simulation (first pattern at 0 ps). By default, signals
|
||||
(except Inputs) are affected with a "full star" value at the first pattern.
|
||||
|
||||
.PP
|
||||
This fonction also set the current pattern.
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
SETTUNIT("ps");
|
||||
AFFECT ("5", "b", "0B1");
|
||||
result : b
|
||||
< 5 ps> :.....1...;
|
||||
.fi
|
||||
|
||||
.PP
|
||||
At simulation date 0 ps the signal b(3 downto 0) receives the value "0001".
|
||||
This value will be kept until the end of the simulation if no more affectation
|
||||
is made.
|
||||
|
||||
.nf
|
||||
SETTUNIT("ns");
|
||||
AFFECT ("0", "b", "0B0");
|
||||
AFFECT ("2", "b", "0B1");
|
||||
result : b
|
||||
< 0 ns> :.....0...;
|
||||
< 2 ns> :.....1...;
|
||||
.fi
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
genpat(1), pat(5)
|
||||
|
||||
|
||||
.so man1/alc_bug_report.1
|
||||
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
.\" $Id: ARRAY.3,v 1.1 2002/05/31 08:27:45 xtof Exp $
|
||||
.\" @(#)ARRAY.3 2.30 UPMC ; VUONG H.N. & PITON D.
|
||||
.TH ARRAY 3 "October 1, 1997" "ASIM/LIP6" "GENPAT functions"
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
\fBARRAY\fP, GENPAT Package
|
||||
|
||||
.so man1/alc_origin.1
|
||||
.SH SYNOPSYS
|
||||
.PP
|
||||
.nf
|
||||
ARRAY ("ident", "ident", ..., ":nb_space", "format", type, option, "ident_group", 0);
|
||||
.fi
|
||||
|
||||
.SH PARAMETERS
|
||||
.PP
|
||||
.TP 10
|
||||
\fIident\fP
|
||||
Name, followed with a number if part of a bused signal, of a connector, a
|
||||
signal or a register. All idents must be of the same type. The name and the
|
||||
number must be separated by a blank or the number must be parenthesized.
|
||||
.TP 10
|
||||
\fInb_space\fP
|
||||
Specify the number of blank space between each group of value. 0,1,2,3,4,5,6,
|
||||
7,8,9 or nothing.
|
||||
.TP 10
|
||||
\fIformat\fP
|
||||
Specify the format that will be used to represent the value associated to
|
||||
the connectors. X for Hexadecimal, O for Octal and B for Binary.
|
||||
.TP 10
|
||||
\fItype\fP
|
||||
Specify the type of the aggregate. REGISTER for Register, SIGNAL for Signal,
|
||||
OUT for Output, IN for Input, INOUT for Input/Output. REGISTER, SIGNAL, OUT,
|
||||
IN, INOUT are constants (defines) provided by genpat.
|
||||
.TP 10
|
||||
\fIoption\fP
|
||||
Specify options of the connectors. "S" for a spied connector, empty ("")
|
||||
for a normal connector.
|
||||
.TP 10
|
||||
\fIident_group\fP
|
||||
Specify the array's name, the first ident is associated with the MSB of the
|
||||
array.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Create a virtual vector with signals of the same type and format. The signals
|
||||
may be either Inputs, Outputs, Inputs/Outputs, Registers or Internal Signals.
|
||||
A vector to be aggregate is to be declared bit per bit (it will appear as a
|
||||
vector in the output file). Outputs, Signals and Registers can be redeclared
|
||||
in a virtual vector. Inputs and Inputs/Outputs CANNOT be redeclared.
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
ARRAY ("cout", "s 9", "s 8", "s 7", ":2", "B", OUT, "S", "Y", 0);
|
||||
|
||||
format : Binary.
|
||||
type : Output connector.
|
||||
option : spied connector.
|
||||
|
||||
each group is separated of the others with 2 blank spaces.
|
||||
result : out Y ( cout, s (9 downto 7) ) B spy ;;;
|
||||
|
||||
ARRAY ("regt", "reg 9", ":2", "B", REGISTER, "", "Y", 0);
|
||||
|
||||
format : Binary.
|
||||
type : Register.
|
||||
option : none.
|
||||
|
||||
each group is separated of the others with 2 blank spaces.
|
||||
result : register Y ( regt, reg (9 downto 9) ) B;;;
|
||||
.fi
|
||||
|
||||
.SH WARNING
|
||||
.PP
|
||||
The ARRAY function from the 4.0 release have a new parameter (option).
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
DECLAR(3), genpat(1), pat(5)
|
||||
|
||||
.SH DIAGNOSTICS
|
||||
.PP
|
||||
You are dealing with a variable number of parameters fonction. If you forget
|
||||
one or more parameter, you will have one of the following results :
|
||||
|
||||
.RS
|
||||
Nothing bad happen, but your result file is erroneous.
|
||||
.br
|
||||
You are asked for more parameter.
|
||||
.br
|
||||
You crash the program and produce a Segmentation Fault.
|
||||
.RE
|
||||
|
||||
.PP
|
||||
In all cases, check your C file for missing parameter.
|
||||
|
||||
|
||||
.so man1/alc_bug_report.1
|
||||
|
||||
|
|
@ -0,0 +1,124 @@
|
|||
.\" $Id: DECLAR.3,v 1.1 2002/05/31 08:27:45 xtof Exp $
|
||||
.\" @(#)DECLAR.3 2.30 UPMC ; VUONG H.N. & PITON D.
|
||||
.TH DECLAR 3 "October 1, 1997" "ASIM/LIP6" "GENPAT functions"
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
\fBDECLAR\fP, GENPAT Package
|
||||
|
||||
.so man1/alc_origin.1
|
||||
.SH SYNOPSYS
|
||||
.PP
|
||||
.nf
|
||||
DECLAR("ident",":nb_space","format",mode,size,option);
|
||||
.fi
|
||||
|
||||
.SH PARAMETERS
|
||||
.PP
|
||||
.TP 10
|
||||
\fIident\fP
|
||||
External connector, internal observing points or register's name. For the
|
||||
hierarchical descriptions, the path-name of the internal observing points
|
||||
or registers must be specified by the syntax : instance1.instance11.name .
|
||||
.TP 10
|
||||
\fInb_space\fP
|
||||
Specify the number of blank space between each group of value associated to
|
||||
the connectors, signals or registers in the output file. 0,1,2,3,4,5,6,7,8,9
|
||||
or nothing.
|
||||
.TP 10
|
||||
\fIformat\fP
|
||||
Specify the format that will be used to represent the value associated to the
|
||||
connectors, signals or registers. X for Hexadecimal, O for Octal and B for
|
||||
Binary.
|
||||
.TP 10
|
||||
\fImode\fP
|
||||
Specify the type of the connectors. IN for Input, OUT for Output, INOUT for
|
||||
Input/Output, SIGNAL for internal observing point, REGISTER for register. IN,
|
||||
OUT, INOUT, SIGNAL, REGISTER are constants (defines) provided by genpat.
|
||||
.TP 10
|
||||
\fIsize\fP
|
||||
Specify the size of the bused connectors : empty ("") for the scalar
|
||||
connectors, "nb1" for the numbered connectors, "nb1 TO nb2" or "(nb1 TO nb2)"
|
||||
(nb1 < nb2), "nb1 DOWNTO nb2" or "(nb1 DOWNTO nb2)" (nb2 < nb1) for the
|
||||
vectors. Where nb1 and nb2 are integer.
|
||||
.TP 10
|
||||
\fIoption\fP
|
||||
Specify options of the connector. "S" for a spied connector, empty ("")
|
||||
for a normal connector.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Describes a set of connectors, signals or registers of the same format, size
|
||||
and mode.
|
||||
|
||||
.SH EXAMPLE
|
||||
.PP
|
||||
.nf
|
||||
DECLAR("a", ":2", "X", OUT, "3 DOWNTO 0", "S");
|
||||
|
||||
describes : a 3, a 2, a 1, a 0
|
||||
format : Hexadecimal.
|
||||
mode : Output.
|
||||
option : Spied connector.
|
||||
|
||||
the group is separated of the others with 2 blank spaces.
|
||||
result :
|
||||
out a(3 downto 0) X spy ;;;
|
||||
|
||||
DECLAR ("toto", ":", "O", INOUT, "7 TO 11", "");
|
||||
|
||||
describes : toto 7, toto 8, toto 9, toto 10, toto 11.
|
||||
format : Octal.
|
||||
mode : Input/Output.
|
||||
option : none.
|
||||
|
||||
the group is separated of the following with 0 blank space.
|
||||
result :
|
||||
inout toto(7 to 11) O ;
|
||||
|
||||
DECLAR ("ck", ":2", "B", IN, "", "");
|
||||
|
||||
describes : ck.
|
||||
format : Binary.
|
||||
mode : Input.
|
||||
option : none.
|
||||
|
||||
the port is separated of the following with 2 blank spaces.
|
||||
result :
|
||||
in ck ;;;
|
||||
|
||||
DECLAR ("accu.f", ":", "B", SIGNAL, "", "S");
|
||||
|
||||
describes : accu.f .
|
||||
format : Binary.
|
||||
mode : Signal.
|
||||
option : Spied connector.
|
||||
|
||||
the signal is separated of the following with 0 blank space.
|
||||
result :
|
||||
signal accu.f spy ;
|
||||
|
||||
DECLAR ("accu.reg", ":1", "B", REGISTER, "(3)", "");
|
||||
|
||||
describes : accu.reg .
|
||||
format : Binary.
|
||||
mode : Register.
|
||||
option : none.
|
||||
|
||||
the signal is separated of the following with 1 blank space.
|
||||
result :
|
||||
register accu.reg(3) ;;;;
|
||||
|
||||
.fi
|
||||
|
||||
.SH WARNING
|
||||
.PP
|
||||
The DECLAR function from the 4.0 release have a new parameter (option).
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
ARRAY(3), genpat(1), pat(5)
|
||||
|
||||
|
||||
.so man1/alc_bug_report.1
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
.\" $Id: DEF_GENPAT.3,v 1.1 2002/05/31 08:27:45 xtof Exp $
|
||||
.\" @(#)DEF_GENPAT.3 2.30 UPMC ; VUONG H.N.
|
||||
.TH DEF_GENPAT 3 "October 1, 1997" "ASIM/LIP6" "GENPAT functions"
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
\fBDEF_GENPAT\fP, GENPAT Package
|
||||
|
||||
.so man1/alc_origin.1
|
||||
.SH SYNOPSYS
|
||||
.PP
|
||||
.nf
|
||||
DEF_GENPAT ("ident");
|
||||
.fi
|
||||
|
||||
.SH PARAMETERS
|
||||
.PP
|
||||
.TP 10
|
||||
\fIident\fP
|
||||
Output file's name without extension.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Gives the output file's name.
|
||||
|
||||
.SH EXAMPLE
|
||||
.PP
|
||||
.nf
|
||||
DEF_GENPAT ("my_file");
|
||||
Declares the output file's name as my_file.<VH_PATSFX>, usually my_file.pat.
|
||||
.fi
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
SAV_GENPAT(3), genpat(1), pat(5)
|
||||
|
||||
|
||||
.so man1/alc_bug_report.1
|
||||
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
.\" $Id: GETCPAT.3,v 1.1 2002/05/31 08:27:45 xtof Exp $
|
||||
.\" @(#)LABEL.3 2.30 UPMC ; PITON D.
|
||||
.TH GETCPAT 3 "October 1, 1997" "ASIM/LIP6" "GENPAT functions"
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
\fBGETCPAT\fP, GENPAT Package
|
||||
|
||||
.so man1/alc_origin.1
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
.nf
|
||||
GETCPAT();
|
||||
.fi
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Return the date of the current pattern (in ps). The current pattern is
|
||||
set by AFFECT or INIT, GETCPAT will return the date of the last modified
|
||||
(affected or initialised) pattern.
|
||||
|
||||
.SH EXAMPLE
|
||||
.PP
|
||||
.nf
|
||||
int t;
|
||||
t = GETCPAT();
|
||||
.fi
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
genpat(1), pat(5), AFFECT(3)
|
||||
|
||||
|
||||
.so man1/alc_bug_report.1
|
||||
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
.\" $Id: INIT.3,v 1.1 2002/05/31 08:27:45 xtof Exp $
|
||||
.\" @(#)INIT.3 2.30 UPMC ; VUONG H.N. & PITON D.
|
||||
.TH INIT 3 "October 1, 1997" "ASIM/LIP6" "GENPAT functions"
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
\fBINIT\fP, GENPAT Package
|
||||
|
||||
.so man1/alc_origin.1
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
.nf
|
||||
INIT("pattern_date","ident","value");
|
||||
.fi
|
||||
|
||||
.SH PARAMETERS
|
||||
.PP
|
||||
.TP 10
|
||||
\fIpattern_date\fP
|
||||
: pattern date which may be either : integer (absolute date) or + integer
|
||||
(relative date, the date of the current pattern (last modified using INIT
|
||||
or AFFECT) is the reference). All dates are supposed to be expressed in
|
||||
the same time unit which may be set only once using SETTUNIT.
|
||||
|
||||
.TP 10
|
||||
\fIident\fP
|
||||
Either the name of a bused register or a simple register. Path-name must be
|
||||
specified by the syntax : instance1.instance11.name
|
||||
.TP 10
|
||||
\fIvalue\fP
|
||||
The value associated with the signal which may be either a based number (ex.
|
||||
0B011 or 0H3F) or a decimal.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Initialize registers at indicated values and set current pattern.
|
||||
|
||||
.SH EXAMPLE
|
||||
.PP
|
||||
.nf
|
||||
SETTUNIT("ns");
|
||||
INIT( "25","regt","0B1");
|
||||
INIT("+50","y 3 downto 0","0xF");
|
||||
|
||||
result :
|
||||
At simulation time 25 ns, the register named regt receive "1"
|
||||
regt <= B"1" ;
|
||||
< 25 ns> : .............;
|
||||
|
||||
At simulation time +50 ns, (related to the date of the current pattern),
|
||||
the vector y is affected with the value 15 in decimal or F in hexadecimal.
|
||||
regt <= X"F" ;
|
||||
< 75 ns> : .............;
|
||||
.fi
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
genpat(1), pat(5), AFFECT(3)
|
||||
|
||||
|
||||
.so man1/alc_bug_report.1
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
.\" $Id: LABEL.3,v 1.1 2002/05/31 08:27:45 xtof Exp $
|
||||
.\" @(#)LABEL.3 2.30 UPMC ; VUONG H.N. & PITON D.
|
||||
.TH LABEL 3 "October 1, 1997" "ASIM/LIP6" "GENPAT functions"
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
\fBLABEL\fP, GENPAT Package
|
||||
|
||||
.so man1/alc_origin.1
|
||||
.SH SYNOPSYS
|
||||
.PP
|
||||
.nf
|
||||
LABEL ("ident");
|
||||
.fi
|
||||
|
||||
.SH PARAMETERS
|
||||
.PP
|
||||
.TP 10
|
||||
\fIident\fP
|
||||
label to be put on the current pattern (last modified using INIT or AFFECT)
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Set \fIident\fP as the label of the current pattern.
|
||||
|
||||
.SH EXAMPLE
|
||||
.PP
|
||||
.nf
|
||||
LABEL ("foo");
|
||||
.fi
|
||||
|
||||
.SH WARNING
|
||||
.PP
|
||||
The LABEL fonction from the 1.9 release doesn't have the same behaviour.
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
genpat(1), pat(5), AFFECT(3)
|
||||
|
||||
|
||||
.so man1/alc_bug_report.1
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
man_MANS = AFFECT.3 ARRAY.3 DECLAR.3 DEF_GENPAT.3 \
|
||||
GETCPAT.3 INIT.3 LABEL.3 SAVE.3
|
||||
|
||||
EXTRA_DIST = $(man_MANS)
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
.\" $Id: SAVE.3,v 1.1 2002/05/31 08:27:46 xtof Exp $
|
||||
.\" @(#)SAVE.3 2.30 Sep 09 1993 UPMC ; VUONG H.N.
|
||||
.TH SAVE 3 "October 1, 1997" "ASIM/LIP6" "GENPAT functions"
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
\fBSAVE\fP, GENPAT Package
|
||||
|
||||
.SH SYNOPSYS
|
||||
.PP
|
||||
.nf
|
||||
SAVE ();
|
||||
.fi
|
||||
|
||||
.so man1/alc_origin.1
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Make the simulator to save the state of the circuit at the end of the
|
||||
simulation.
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
SAVE ();
|
||||
.fi
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
genpat(1), pat(5), asimut(1)
|
||||
|
||||
|
||||
.so man1/alc_bug_report.1
|
||||
|
||||
Loading…
Reference in New Issue