github.com/wfjm.w11
1
0
Fork 0
mirror of https://github.com/wfjm/w11.git synced 2026-01-12 00:43:01 +00:00
Code Issues Releases Wiki Activity

man pages: spelling/grammar updates [skip ci]

Browse Source
This commit is contained in:
wfjm 2022-05-01 08:35:23 +02:00
parent a5640780d9
commit d1d95504df
32 changed files with 295 additions and 294 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
tools/man/man1/asm-11_expect.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: asm-11_expect.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: asm-11_expect.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2014-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -24,12 +24,12 @@ asm-11_expect \- expect checker for asm-11 test bench
.SH DESCRIPTION
Reads one of more \fBasm-11\fP(1) listing files and checks for unexpected
assembly errors and tests for expected address and generated data values.
What is expected is specified by comments, described in section EXPECT COMMENTS,
which are added to the asm-11 source code.
What is expected is specified by comments, described in the
section EXPECT COMMENTS, which are added to the asm-11 source code.
asm-11 will copy these comments to the listing file and asm-11_expect extracts
them and checks whether the actual assembly results match the expected ones.
.PP
asm-11_expect produces at least a one line summary per file like
asm-11_expect produces at least a one-line summary per file like
.PP
.EX
asm-11_expect: test_0010_alloc.lst OK
@ -37,7 +37,7 @@ asm-11_expect produces at least a one line summary per file like
.EE
.PP
where each file is marked either \fBOK\fR or \fBFAILED\fR.
In case of detected errors additional output follows which gives a description
In case of detected errors additional output follows which describes
of each error and the affected listing line, like
.PP
.EX
@ -46,7 +46,7 @@ of each error and the affected listing line, like
in: 1 27 001042 067700 177736 add @pa,r0 ;;!! 067700 177734
.EE
.PP
Main application for asm-11_expect is to build self-checking test benches
Main application for asm-11_expect is to build a self-checking test benches
for \fBasm-11\fP(1).
.
.
@ -63,7 +63,7 @@ with
.PP
.PD 0
.IP "\fBetags\fP"
list of expected assembly error flags, given as sequence of uppercase letters
list of expected assembly error flags, given as a sequence of uppercase letters
without white space between letters.
.IP "\fBaddr\fP"
expected location counter (value of '.'), given as 6 digit octal number.
@ -74,7 +74,7 @@ of either 3 (for byte output) or 6 (for word output) digit octal numbers.
Again, all 3 or 6 digits must be specified, even leading zeros.
This is checked against the data section of the assembly listing.
.br
In general this is used to check data emitted into the binary output.
In general, this is used to check data emitted into the binary output.
However, some assembler statements, e.g. assignments or directives like .end,
indicate some result value in data section, and this can of course be
checked as well.
@ -86,19 +86,19 @@ been generated for the line. Address and data tests are only done in case
\fIaddr\fP or \fIdata\fP components have been given.
.PP
If a line starts with an expect comment it will be applied to the asm-11
statement in the following line. Or it is simply appended to a asm-11
statement in the following line. Or it is simply appended to an asm-11
statement.
.SS Comment examples
.IP "\fB;;!! DM\fR" 4
expect a D and a M error flag
.IP "\fB;;!! 001020:\fR"
expect that current location will be 001020, data not checked
expect that the current location will be 001020, data not checked
.IP "\fB;;!! 074167 177762\fR"
expect that the listing data section shows two words, 074167 and 177762.
Address is not checked.
The address is not checked.
.IP "\fB;;!! 001004: 000207\fR"
expect that current location will be 001004 and that the listing data section
shows one word with value 000207.
expect that the current location will be 001004 and that the listing data section
shows one word with the value 000207.
.SS Some practical cases
.EX
@ -160,8 +160,8 @@ at least one expect FAILed, test bench has FAILed
.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBasm-11_expect *.lst\fR" 4
Will check all listing files in current directory and produce a listing with
at least one summary line per file as described in section DESCRIPTION.
Will check all listing files in the current directory and produce a listing
with at least one summary line per file as described in section DESCRIPTION.
.\" ------------------------------------------------------------------
.SH "SEE ALSO"

14
tools/man/man1/config_wrapper.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: config_wrapper.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: config_wrapper.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -65,8 +65,8 @@ Xilinx SP605. Default path: xc6slx45t
.
.\" ----------------------------------------------
.IP \fB\-\-path=\fIp\fR
determines the type of FPGA to be configured. It usually properly defaulted
based on the \fB\-\-board\fP option. Only in cases were a board is available
determines the type of FPGA to be configured. It is usually properly defaulted
based on the \fB\-\-board\fP option. Only in cases where a board is available
with several die sizes this option will be needed.
.
.\" ----------------------------------------------
@ -78,22 +78,22 @@ print help text and exit.
.
.\" ----------------------------------------------
.IP \fBbit2svf\fP
Convert a FPGA configuration file from \fI.bit\fP format (the native XILINX
Convert an FPGA configuration file from \fI.bit\fP format (the native XILINX
format) to \fI.svf\fP format (the portable Serial Vector Format). The
XILINX ISE \fBimpact\fP program is used, the input \fIFILE\fP must be in
\fI.bit\fP format.
.
.\" ----------------------------------------------
.IP \fBiconfig\fP
Configure a FPGA with XILINX ISE \fBimpact\fP. The input \fIFILE\fP must be in
Configure an FPGA with XILINX ISE \fBimpact\fP. The input \fIFILE\fP must be in
\fI.bit\fP format.
.
.\" ----------------------------------------------
.IP \fBjconfig\fP
Configure a FPGA with \fBjtag\fP(1). The input \fIFILE\fP must be in
Configure an FPGA with \fBjtag\fP(1). The input \fIFILE\fP must be in
\fI.svf\fP format. This sub command is usually used for boards with a
Cypress FX2 USB controller, like the Digilent Nexys2, Nexys3 or Atlys,
and a FX2 firmware which emulates an Altera USB-Blaster programming cable.
and an FX2 firmware that emulates an Altera USB-Blaster programming cable.
The USB device path is defined by the environment variables RETRO_FX2_VID
and RETRO_FX2_PID, or defaults to vid=16c0 and pid=03ef.

18
tools/man/man1/console_starter.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: console_starter.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: console_starter.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013-2014 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -25,12 +25,12 @@ console_starter \- setup vt52/vt100 emulator windows for ti_rri or simh
.
.\" ------------------------------------------------------------------
.SH DESCRIPTION
Script to setup a \fBxterm\fP vt52 or vt100 emulator window which
Script to setup an \fBxterm\fP vt52 or vt100 emulator window which
will connect to a DL11 or DZ11 serial interface emulation port of
\fBti_rri\fP or a CPU emulator from the \fBsimh\fP suite,
e.g. \fBpdp11\fP, via a \fBtelnet\fP connection.
If the connect to the interface emulation port fails or is terminated
If the connection to the interface emulation port fails or is terminated
a message like
.EX
@ -84,7 +84,7 @@ eight lines of the first DZ11. \fIn\fP = 0,...,7.
.
.\" ----------------------------------------------
.IP "\fB\-s\fR"
Use simh port numbers. Default is to use \fBti_rri\fP ports.
Use simh port numbers. The default is to use \fBti_rri\fP ports.
.
.\" ----------------------------------------------
.IP "\fB\-w\fR"
@ -101,19 +101,19 @@ print full help text and exit.
.
.\" ------------------------------------------------------------------
.SH EXIT STATUS
In case of an error an exit status 1 is returned.
In case of an error, an exit status 1 is returned.
.
.
.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBconsole_starter -d DL0 &\fR" 4
Creates a background process with a \fBxterm\fP in VT100 emulation mode
with a 80x24 screen size which will try to connect to the primary DL11
Creates a background process with an \fBxterm\fP in VT100 emulation mode
with a 80x24 screen size which will try to connect to the primary DL11
emulator port of \fBti_rri\fP.
.
.IP "\fBconsole_starter -t vt52 -d DL1 -s &\fR"
Creates a background process with a \fBxterm\fP in VT52 emulation mode
with a 80x24 screen size which will try to connect to the secondary DL11
Creates a background process with an \fBxterm\fP in VT52 emulation mode
with an 80x24 screen size which will try to connect to the secondary DL11
emulator port of a \fBsimh\fP suite CPU emulator.
.
.\" ------------------------------------------------------------------

18
tools/man/man1/create_disk.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: create_disk.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: create_disk.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013-2015 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -40,7 +40,7 @@ option.
.
.\" ----------------------------------------------
.IP \fB\-\-ini=\fIpat\fR
determines whether the container file will be initialized with specific
determines whether the container file will be initialized with a specific
data pattern. Note that the \fB\-\-bad\fP and \fB\-\-boot\fP options will
overwrite the last track or the first sector(s) respectively.
The default without \fB\-\-ini\fR is to create a container with all zero data.
@ -50,7 +50,7 @@ the actual allocation of disk space to the point when sectors are written.
Allowed values for \fIpat\fP are
.RS
.IP \fBzero\fP
creates a disk with all sectors zero'ed. In this case zero's are explicitely
creates a disk with all sectors zero'ed. In this case zero's are explicitly
written. The explicit allocation of disk space is the main effect of this
option.
.IP \fBones\fP
@ -70,13 +70,13 @@ absolute disk byte address, lower word
.IP 1: 4
absolute disk byte address, upper word
.IP 2: 4
current cyclinder number (0 based)
current cylinder number (0 based)
.IP 3: 4
current track/head number (0 based)
.IP 4: 4
current sector number (0 based)
.IP 5: 4
number of cyclinders for disk type
number of cylinders for disk type
.IP 6: 4
number of tracks/heads for disk type
.IP 7: 4
@ -143,16 +143,16 @@ can not be created an exit status 1 is returned.
.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBcreate_disk -typ=rk05 rk05.dsk\fR" 4
This will create a zero'ed disk contained sized for a RK05 disk. In most
This will create a zero'ed disk contained sized for an RK05 disk. In most
cases it is sufficient to create such plain zero'ed disk images.
.
.IP "\fBcreate_disk -typ=rl02 -bad rl02.dsk\fR"
Creates a RL02 sized disk with a 'factory bad block table'. When using
RLxx, RPxx, or RMxx type disks, especially in conjunction with DEC
Creates an RL02 sized disk with a 'factory bad block table'. When using
RLxx, RPxx, or RMxx type disks, especially in conjunction with DEC
operating systems, it is advisable to create disks with \fB\-\-bad\fP.
.
.IP "\fBcreate_disk -typ=rk05 -ini=test rk05_test.dsk\fR"
Creates a RK05 sized disk with test pattern.
Creates an RK05 sized disk with test pattern.
.
.\" ------------------------------------------------------------------
.SH "SEE ALSO"

16
tools/man/man1/dmpcntanal.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: dmpcntanal.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: dmpcntanal.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2018- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -23,7 +23,7 @@ dmpcntanal \- analyze dmpcnt data
.\" ------------------------------------------------------------------
.SH DESCRIPTION
Reads a list of CPU performance counter raw data, usually generated via
a \fIrw11::pc_lsta\fR command, and generates human readable reports.
a \fIrw11::pc_lsta\fR command, and generates human-readable reports.
.
.\" ------------------------------------------------------------------
.SH OPTIONS
@ -57,7 +57,7 @@ show the CPU events columns
instruction rate in MHz
.PD 0
.IP \fIvfetc\fP
vector fetch rate, sum of traps, exceptions and interrupts.
vector fetch rate, sum of traps, exceptions, and interrupts.
.IP \fIirupt\fP
interrupt rate
.IP \fIi/b\fP
@ -135,12 +135,12 @@ average number of ibus wait cycles (read and write combined).
.
.\" ----------------------------------------------
.IP "\fB\-\-raw\fR=\fIclist\fR"
show raw data of the counters given in the comma separated list of
show raw data of the counters given in the comma-separated list of
counter names \fIclist\fR.
.
.\" ----------------------------------------------
.IP "\fB\-\-dat\fR=\fIclist\fR"
show data rate of the counters given in the comma separated list of
show data rate of the counters given in the comma-separated list of
counter names \fIclist\fR.
.
.\" ----------------------------------------------
@ -153,8 +153,8 @@ text for header. The length if the header must be equal or less than the
width of the format.
.PD 0
.IP \fBfmt\fP
format in the form like \fIw.p\fR with a single digit field width \fIw\fR
and single digit precision \fIp\fR. If \fIp\fR is \fI0\fR no decimal point
format in the form like \fIw.p\fR with a single-digit field width \fIw\fR
and single-digit precision \fIp\fR. If \fIp\fR is \fI0\fR no decimal point
is printed. If omitted \fI4.1\fR is assumed.
.IP \fBmul\fP
multiplier, given as integer of floating point number.
@ -245,7 +245,7 @@ also be created via the \fB-fmt\fR option with the following parameters
reads the file \fIpc_dmpcnt_xxx.dat\fR and generates a report with the
\fB-cstate\fR and \fB-cevent\fR columns sets.
The input file is typically generated by a \fBti_w11\fR tcl command like
The input file is typically generated by a \fBti_w11\fR Tcl command like
.EX
rw11::pc_clear

4
tools/man/man1/dmscntanal.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: dmscntanal.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: dmscntanal.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2015- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -22,7 +22,7 @@ dmscntanal \- analyze dmscnt data
.\" ------------------------------------------------------------------
.SH DESCRIPTION
Analyses converted dmscnt data, which was generated by \fBdmscntconv\fR(1)
from w11a dmscnt unit raw data. Currently only some build-in statistics
from w11a dmscnt unit raw data. Currently, only some build-in statistics
is shown.
.
.\" ------------------------------------------------------------------

12
tools/man/man1/dmscntconv.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: dmscntconv.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: dmscntconv.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2015- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -23,10 +23,10 @@ dmscntconv \- convert dmscnt data
.\" ------------------------------------------------------------------
.SH DESCRIPTION
Converts the raw data generated by the w11a dmscnt unit, the embedded
micro state counter, into a human readable format. The raw data is
usually generated by a \fBti_w11\fR tcl command \fIrw11::sc_read\fR
micro state counter, into a human-readable format. The raw data is
usually generated by a \fBti_w11\fR Tcl command \fIrw11::sc_read\fR
and contains counter index and counter values as hex data.
\fBdmscntconv\fR will convert this into a human readable table of state
\fBdmscntconv\fR will convert this into a human-readable table of state
numbers, state names and state counts for kernel and non-kernel modes.
The state names are retrieved from the \fIpdp11_sequencer.vhd\fR source file,
the path to and name of the source file can be specified with the
@ -49,9 +49,9 @@ print full help text and exit.
.SH EXAMPLES
.IP "\fBdmscntconv xxx.dat > xxx.scnt\fR" 4
reads the file \fIxxx.dat\fR and stores the output in \fIxxx.scnt\fR.
Because no \fB\-\-src\fR option is given the default sequencer file will used.
Because no \fB\-\-src\fR option is given the default sequencer file will be used.
The input raw data file is typically generated by a \fBti_w11\fR tcl command
The input raw data file is typically generated by a \fBti_w11\fR Tcl command
like
.EX

6
tools/man/man1/file2tap.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: file2tap.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: file2tap.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2015- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -31,11 +31,11 @@ file2tap \- create a tap format tape container from individual files
Creates (\fB-c\fR) a new or appends (\fB-a\fR) to an existing tap format tape
container file \fTNAM\fR and adds files. The tape record size is specified
with a \fB-b\fR option followed by the record size in units 512 bytes.
Each tape file is build from a comma separated list of disk files \fIFLIST\fR,
Each tape file is built from a comma-separated list of disk files \fIFLIST\fR,
which are concatenated and written with a record size given by the last
\fB-b\fR option.
\fBfile2tap\fR writes to stdout a one line message for each created file which
\fBfile2tap\fR writes to stdout a one-line message for each created file which
gives the file number, number of records, the record size in bytes and the
names of the disk files used to build the tape file.
.

10
tools/man/man1/fx2load_wrapper.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: fx2load_wrapper.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: fx2load_wrapper.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -33,12 +33,12 @@ The command locates a USB device with a USB path defined by the environment
variables RETRO_FX2_VID and RETRO_FX2_PID, or default vid=16c0 and pid=03ef.
It inquires with \fBlsusb\fP(1) the 'iProduct' attribute of the currently
active USB descriptor. If this attribute is defined and equals the basename
of the firmware image given with \fB-\-file\fP it is assumed the the proper
of the firmware image given with \fB-\-file\fP it is assumed the proper
firmware is already active. Otherwise the firmware image is loaded with
either \fBfxload\fP(1) or \fBcycfx2prog\fP.
\fBNote:\fP after a firmware load the Cypress FX2 USB controller restarts.
This causes a USB re-numeratation, the USB device disconnects and reconnects
This causes a USB re-enumeratation, the USB device disconnects and reconnects
with a new device descriptor. It can take some time till the Linux USB stack
shows the new device descriptor. The command sleeps for 1.5 seconds, this is
usually enough to ensure that subsequent commands see the new state.
@ -90,7 +90,7 @@ print help text and exit.
.
.\" ------------------------------------------------------------------
.SH EXIT STATUS
In case of an error an exit status 1 is returned.
In case of an error, an exit status 1 is returned.
.
.\" ------------------------------------------------------------------
.SH ENVIRONMENT
@ -99,7 +99,7 @@ Define the USB path of the Cypress FX2 USB controller. If not specified
the defaults vid=16c0 and pid=03ef are used.
.IP \fBRETROBASE\fR
Path to current Retro project root directory. Used for the default
firmware path in case no \fB\-\-ihx_path\fP option given.
firmware path in case no \fB\-\-ihx_path\fP option is given.
.
.\" ------------------------------------------------------------------
.SH EXAMPLES

20
tools/man/man1/github_md2html.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: github_md2html.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: github_md2html.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2017-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -8,7 +8,7 @@
.TH GITHUB_MD2HTML 1 2018-11-03 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
github_md2html \- convert markdown to html with GitHub API
github_md2html \- convert markdown to HTML with GitHub API
.\" ------------------------------------------------------------------
.SH SYNOPSIS
.
@ -19,16 +19,16 @@ github_md2html \- convert markdown to html with GitHub API
.
.\" ------------------------------------------------------------------
.SH DESCRIPTION
Converts markdown files to html using the GitHub converter API.
Converts Markdown files to HTML using the GitHub converter API.
\fIFILE\fP can either be a file name or a directory name (e.g. '.').
If it's a directory, the whole sub-tree will be scanned and all files
with an extension of \fI.md\fP will be converted.
The created html files have the extension \fI.md.html\fP.
The created HTML files have the extension \fI.md.html\fP.
Unless the \fB-force\fP option is given the script checks whether the
\fI.md.html\fP
file already exists and converts only when the markdown file is newer than
the html file.
the HTML file.
.
.\" ------------------------------------------------------------------
.SH OPTIONS
@ -39,11 +39,11 @@ re-create all files, even when they exist and are up-to-date.
.
.\" ----------------------------------------------
.IP "\fB\-standalone\fR"
modify local links for usage with local browser. All links pointing to a
local \fI.md\fP file will be redirected to the \fI.md.html\fP file, and
modify local links for usage with a local browser. All links pointing to a
local \fI.md\fP file will be redirected to the \fI.md.html\fP file and
all links pointing to a local directory will be redirected to a
\fIREADME.md.html\fP in case the directory README exists.
This mode is is useful when one wants to inspect the files directly
This mode is useful when one wants to inspect the files directly
with a browser.
.
.\" ----------------------------------------------
@ -51,7 +51,7 @@ with a browser.
trace link mapping in \fI-standalone\fP mode.
.\" ----------------------------------------------
.IP "\fB\-verbose\fR"
print status of each inspected file. Default is to list only converted files.
print status of each inspected file. The default is to list only converted files.
.
.\" ----------------------------------------------
.IP "\fB\-context \fIcont\fR"
@ -67,7 +67,7 @@ print help text.
.
.\" ------------------------------------------------------------------
.SH EXIT STATUS
In case of an error an exit status 1 is returned.
In case of an error, an exit status 1 is returned.
.
.
.\" ------------------------------------------------------------------

10
tools/man/man1/ip_create_br.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: ip_create_br.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: ip_create_br.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2017- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -21,17 +21,17 @@ ip_create_br \- create bridge and re-connect ethernet interface
This script expects a default single Ethernet interface setup, creates
a bridge named 'br0', and re-connects Ethernet interface to this bridge.
The scripts bails out gracefully in case 'br0' already exists. In not, it
The script bails out gracefully in case 'br0' already exists. In not, it
determines the name of the Ethernet interface, accepting both old 'eth*' and
new 'en*' naming, and verifies that it is a single Ethernet configuration.
Than it creates a bridge device named 'br0' and re-connects the physical
Then it creates a bridge device named 'br0' and re-connects the physical
Ethernet interface to the bridge, preserving all IP addresses and routes.
This script is part of setting up tap devices with \fBip_create_tap\fR(1)
but can be used independently.
The script should be started as normal user, but uses \fBsudo\fR(8) to
execute priviledged commands and might therefore ask for the user password.
The script should be started as a normal user, but uses \fBsudo\fR(8) to
execute privileged commands and might therefore ask for the user password.
.
.\" ------------------------------------------------------------------
.SH "SEE ALSO"

14
tools/man/man1/ip_create_tap.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: ip_create_tap.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: ip_create_tap.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2017- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -19,16 +19,16 @@ ip_create_tap \- add a user-mode tap device to a bridge
.\" ------------------------------------------------------------------
.SH DESCRIPTION
This script adds user-mode a tap device to a bridge, and creates the bridge
This script adds user-mode a tap device to a bridge and creates the bridge
in case it doesn't exist already.
The script first checks whether 'br0' exists, if not \fBip_create_br\fR(1)
is executed. Than a tap device is created, named \fITAPNAME\fP or 'tap0'
by default. The tap device will be accessible for the user which executes
the script. Finally the created tap device is connected to bridge 'br0'.
is executed. Then a tap device is created, named \fITAPNAME\fP or 'tap0'
by default. The tap device will be accessible to the user which executes
the script. Finally, the created tap device is connected to bridge 'br0'.
The script should be started as normal user, but uses \fBsudo\fR(8) to
execute priviledged commands and might therefore ask for the user password.
The script should be started as a normal user, but uses \fBsudo\fR(8) to
execute privileged commands and might therefore ask for the user password.
.
.\" ------------------------------------------------------------------

6
tools/man/man1/njobihtm.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: njobihtm.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: njobihtm.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -31,7 +31,7 @@ determines the number of physical cores and the number of threads per core
assumes that only a quarter of the additional hyper-threads are useful
.IP "-"
if \fB-m\fP is given. determines the memory size, assumes that at least
one GB should be available for general usage, and limits the number of
one GB should be available for general usage and limits the number of
jobs accordingly.
.PD
.RE
@ -44,7 +44,7 @@ The number of jobs is written to STDOUT, and can be used like `njobs`.
.\" -- --mem -------------------------------------
.IP \fB\-m\ \fIsize\fR
gives the required physical memory per job.
\fIsize\fP must be given as integer with either a 'M' or 'G', indicating MB
\fIsize\fP must be given as an integer with either a 'M' or 'G', indicating MB
or GB.
.
.\" -- --verbose ---------------------------------

4
tools/man/man1/svn_set_ignore.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: svn_set_ignore.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: svn_set_ignore.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -26,7 +26,7 @@ of all \fI.gitignore\fP files found in the directory hierarchy.
.
If no \fIsvn:ignore\fP property exists or the existing one differs from
the ignore pattern list determined from the top level and local
\f.gitignore\fP file the property is set or updated.
\fI.gitignore\fP file the property is set or updated.
.
.\" ------------------------------------------------------------------
.SH OPTIONS

14
tools/man/man1/tap2file.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tap2file.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: tap2file.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2015-2019 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -28,8 +28,8 @@ individual disk file. The created files are named \fIpref\fR_nn.dat, where
\fIpref\fR is either the prefix given with the \fB\-\-pref\fR option or the
stem of \fIFILE\fR.
\fBtap2file\fR writes to stdout a one line message for each created file which
gives the filename, the number of tape records and the record length. In case
\fBtap2file\fR writes to stdout a one-line message for each created file which
gives the filename, the number of tape records, and the record length. In case
the record length is variable the minimal and the maximal record length is given.
.
.\" ------------------------------------------------------------------
@ -37,13 +37,13 @@ the record length is variable the minimal and the maximal record length is given
.
.\" ----------------------------------------------
.IP "\fB\-pref\fR=\fIp\fR"
use \fIp\fR as prefix to generate the names of all generated file. If not
use \fIp\fR as a prefix to generate the names of all generated files. If not
specified the stem of the input file name is taken.
.
.\" ----------------------------------------------
.IP "\fB\-v\fR"
verbose mode, prints a message per processed record which contains file number,
record number, record length and the first 16 bytes as hex dump. EOF and
record number, record length, and the first 16 bytes as hex dump. EOF and
EOT markers are also indicated. Can be useful for tapes with varying record
length files or for debugging.
.
@ -70,12 +70,12 @@ Because no \fB\-\-pref\fR option is given the output files will be named
.EE
which indicates that the first file had 512 byte records, the next four 1024
byte records, and the remaining ones 10240 byte records. In case of a tape
byte records, and the remaining ones 10240 byte records. In the case of a tape
generated by a Unix system a record length of 10240 is a good hint this the
file contains a \fBtar\fR(1) archive.
.IP "\fBtap2file -v test.tap\fR" 4
reads the file \fItest.tap\fR and writes a one line trace info for each record.
reads the file \fItest.tap\fR and writes a one-line trace info for each record.
The stdout output might look like
.EX

24
tools/man/man1/tbfilt.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbfilt.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: tbfilt.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -32,7 +32,7 @@ It can be used in two modes:
.RS 2
.IP "-" 2
as filter during test bench execution, typically in a setup like
as a filter during test bench execution, typically in a setup like
.EX
tbw <test_bench> 2>&1 | tbfilt --tee=<log_file>
.EE
@ -47,10 +47,10 @@ pipeline with a very involved egrep selection expression.
The exit status of tbfilt is 1 in case the test is considered as \fBFAIL\fPed.
.
.IP "-" 2
as log file analysis tool. In this case the test bench log files are either
as log file analysis tool. In this case, the test bench log files are either
specified explicitly as arguments or determined via the \fB\-\-find\fP or
\fB\-\-all\fP options.
If the \fB\-\-summary\fP option is specified a one line summary for each
If the \fB\-\-summary\fP option is specified a one-line summary for each
test log file is displayed. The format of this summary is configurable via
the \fB\-\-format\fP, \fB\-\-wide\fP, and \fB\-\-compact\fP options and via
the \fB\TBFILT_FORMAT\fP environment variable.
@ -61,7 +61,7 @@ The exit status of tbfilt is 1 in case any of the tests is considered as
.PP
.
.SS Filter Criteria
A line which contains any of the following strings is considered as an
A line that contains any of the following strings is considered as an
indication of a \fBFAIL\fPed test:
.RS 2
.PD 0
@ -75,15 +75,15 @@ indication of a \fBFAIL\fPed test:
.PD
.RE
As excption to the general rules above the following assertion messages
As an exception to the general rules above the following assertion messages
are accepted:
Assertion warnings from IEEE libraries at startup (t=0) are ignored. They are
hard to avoid in complex models and in general don't indicate a real issue.
hard to avoid in complex models and generally don't indicate a real issue.
.RS 2
.PD 0
.IP "-" 2
assertion warnings from IEEE libraries at startup (t=0). They are hard to
avoid in complex models and in general don't indicate a real issue. Best
avoid in complex models and in general don't indicate a real issue. The best
is to suppress them in \fBghdl\fP(1) with the
option '--ieee-asserts=disable-at-0'.
.IP "-" 2
@ -100,7 +100,7 @@ tbfilt also expects a line in one of the formats
.EE
and considers a test \fBFAIL\fPed if it is missing.
In addition lines containing
In addition, lines containing
.RS 4
.PD 0
.IP "\fB-W:\fR"
@ -202,11 +202,11 @@ information. Uses a format of "%fd %fs %tr %tc %sc %ec %pf %nf".
.\" -- --compact ---------------------------------
.IP \fB\-\-compact\fP
Selects a compact format for summary outputs, designed to give the key info
on a 80 character wide line. Uses a format of "%fa %tg %sg %ec %pf %ns".
on an 80 character wide line. Uses a format of "%fa %tg %sg %ec %pf %ns".
.
.\" -- --nohead ----------------------------------
.IP \fB\-\-nohead\fP
Suppresses the head line of summary outputs. Useful of summary output is
Suppresses the headline of summary outputs. Useful of summary output is
piped into sort or other tools.
.
.\" -- --format ----------------------------------
@ -236,7 +236,7 @@ system time of test bench run
.IP \fB%tc\fP
total cpu (user+system) time of test bench run
.IP \fB%tg\fP
show '%tc c' if cpu time significant, otherwise '%tr r'
show '%tc c' if cpu time is significant, otherwise '%tr r'
.IP \fB%st\fP
simulation time in ns
.IP \fB%ss\fP

30
tools/man/man1/tbrun.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbrun.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: tbrun.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016-2019 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -25,8 +25,8 @@ tbrun \- test bench driver
.PD 0
.IP "-" 2
read the file \fIDSCFILE\fP, which describes the full set of test benches.
The top level \fIDSCFILE\fP typically includes other files which allows to
organize the description in a well structured manner. If no \fIDSCFILE\fP
The top-level \fIDSCFILE\fP typically includes other files which allow
organizing the description in a well-structured manner. If no \fIDSCFILE\fP
is specified the file \fItbrun.yml\fP in the current working directory is
used.
.IP "-"
@ -38,7 +38,7 @@ the simulation type, behavioral or post-synthesis or later. See section
MODES for details.
.IP "-"
execute the tests which as much parallelism as possible. The \fB\-\-jobs\fP
option specifies the maximal number of jobs, and a locking logic prevents that
option specifies the maximal number of jobs and a locking logic prevents that
more than one test is run in one working directory.
.PD
.RE
@ -50,7 +50,7 @@ more than one test is run in one working directory.
.\" -- --tag -------------------------------------
.IP \fB\-\-tag=\fItlist\fR
specifies the tags a test must match to be selected for execution.
\fItlist\fR can be a comma separated list of tags, a test must match
\fItlist\fR can be a comma-separated list of tags, a test must match
all tags given in \fItlist\fR to be selected.
.br
\fB\-\-tag\fP can be specified multiple times, the selections are ored.
@ -62,8 +62,8 @@ assumed, so all tests with the tag 'default' are executed.
.
.\" -- --exclude ---------------------------------
.IP \fB\-\-exclude=\fItlist\fR
specifies the tags a test must not match. \fItlist\fR can again be a comma
separated list, a test which matches all the tags given is excluded.
specifies the tags a test must not match. \fItlist\fR can again be a
comma-separated list, a test that matches all the tags given is excluded.
.br
\fB\-\-exclude\fP can be specified multiple times, the rejections are ored.
In effect, a test is rejected if it matches all tags in the \fItlist\fR of
@ -72,7 +72,7 @@ one of the specified \fB\-\-exclude\fP options.
.\" -- --all -------------------------------------
.IP \fB\-\-all\fR
is simply a shortcut for \fB\-\-tag=".*"\fR and selects all tags. Can be
combined with \fB\-\-exclude\fP but not with other \fB\-\-tag\P options.
combined with \fB\-\-exclude\fP but not with other \fB\-\-tag\fP options.
.
.\" -- --mode ------------------------------------
.IP \fB\-\-mode=\fImlist\fR
@ -155,7 +155,7 @@ number of tasks still waiting for execution
.IP "*w"
number of tasks currently running
.IP "*o"
number of tasks in pending output queue
number of tasks in the pending output queue
.PD
.RE
@ -165,7 +165,7 @@ buffering and progress line output even when \fInjob\fP is '1' !
.
.\" -- --tee -------------------------------------
.IP \fB\-\-tee=\fIoutfile\fR
if specified the all output send to stdout with the exception of the
if specified all output send to stdout except for the
progress line updates is also written in the file \fIoutfile\fR.
This is very convenient in conjunction with the \fB\-\-jobs\fP option
which generates progress line output only when stdout is a terminal
@ -199,7 +199,7 @@ based test benches.
.
\" -- --norun -----------------------------------
.IP \fB\-\-norun\fP
don't execute run step of test bench, useful to only execute make step.
don't execute run step of the test bench, useful to only execute make step.
Will be forwarded to \fBtbrun_tbw\fP(1) and \fBtbrun_tbwrri\fP(1)
based test benches.
.
@ -216,13 +216,13 @@ based test benches.
.\" -- --bwait ----------------------------------
.IP \fB\-\-bwait=\fItwait\fR
specifies startup wait for behavioral simulations.
\fItwait\fR must be an integer, time unit is 1 ns. Will be forwarded
\fItwait\fR must be an integer, the time unit is 1 ns. Will be forwarded
to \fBtbrun_tbwrri\fP(1) based test benches.
.
.\" -- --swait ----------------------------------
.IP \fB\-\-swait=\fItwait\fR
specifies startup wait for post-synthesis and higher simulations.
\fItwait\fR must be an integer, time unit is 1 ns. Will be forwarded
\fItwait\fR must be an integer, the time unit is 1 ns. Will be forwarded
to \fBtbrun_tbwrri\fP(1) based test benches.
.
\" -- --help -------------------------------------
@ -244,8 +244,8 @@ at least one test FAILed, test bench has FAILed
.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBtbrun" 4
Simplest default case, will use the \fItbrun.yml\fP file in the current
working directory, assume \fI\-\-tag=default\fP and \fI\-\-mode=bsim\fP
The simplest default case, will use the \fItbrun.yml\fP file in the current
working directory, assume \fI\-\-tag=default\fP, and \fI\-\-mode=bsim\fP
and this select all tests tagged with 'default' and run the behavioral
simulation with \fBghdl\fP(1). Done in simple sequential mode.
.IP "\fBtbrun --jobs=2 --tag=viv,sys_w11a --mode=XSim" 4

10
tools/man/man1/tbrun_tbw.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbrun_tbw.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: tbrun_tbw.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -31,14 +31,14 @@ issue a \fBmake\fP(1) command to (re)-build \fITBENCH\fP.
build a \fBtbw\fP(1) command, using \fISTIMFILE\fP if specified.
.IP "-"
create a shell pipe to which runs tbw and handles the test bench output with
\fBtbfilt\fP(1) to determine success of failure.
\fBtbfilt\fP(1) to determine success or failure.
.PD
.RE
.PP
.
.\" ------------------------------------------------------------------
.SH OPTIONS
Note: \fBtbrun_tbw\fP is implemented as shell script. If options have an
Note: \fBtbrun_tbw\fP is implemented as a shell script. If options have an
argument it is separated white space and not by '='! So write '--ghw\ xxx'
and not '--ghw=xxx' !
.
@ -56,7 +56,7 @@ don't execute test bench (useful to only execute make step)
.
.\" -- --lsuf ------------------------------------
.IP \fB\-\-lsuf\ \fIsuff\fR
use '_\fIsuff\fR.log' as suffix for log file. Default is '_bsim.log'
use '_\fIsuff\fR.log' as a suffix for the log file. Default is '_bsim.log'
.
.\" -- --stack -----------------------------------
.IP \fB\-\-stack\ \fInnn\fR
@ -82,7 +82,7 @@ Simplest default case, will execute in essence
tbw tb_serport_uart_rx 2>&1 | tbfilt
.EE
The issued command is more involved, defines TIMEFORMAT, adds a bash 'time',
and some redirects to ensure that the 'time' output ends up un the log file.
and some redirects to ensure that the 'time' output ends up in the log file.
.\" ------------------------------------------------------------------
.SH "SEE ALSO"

10
tools/man/man1/tbrun_tbwrri.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbrun_tbwrri.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: tbrun_tbwrri.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -39,15 +39,15 @@ setup commands resulting from \fB\-\-cuff\fP, \fB\-\-fusp\fP, ...
all optional \fICOMMANDS\fP
.IP "-" 2
create shell pipe to filter the output with \fBtbfilt\fP(1) to determine
success of failure.
the success or failure.
.PD
.RE
.PP
.
.\" ------------------------------------------------------------------
.SH OPTIONS
Note: \fBtbrun_tbwrri\fP is implemented as shell script. If options have an
argument it is separated white space and not by '='! So write '--ghw\ xxx'
Note: \fBtbrun_tbwrri\fP is implemented as a shell script. If options have an
argument it is separated by white space and not by '='! So write '--ghw\ xxx'
and not '--ghw=xxx' !
.
.\" -- --dry -------------------------------------
@ -64,7 +64,7 @@ don't execute test bench (useful to only execute make step)
.
.\" -- --lsuf ------------------------------------
.IP \fB\-\-lsuf\ \fIsuff\fR
use '_\fIsuff\fR.log' as suffix for log file. Default is '_bsim.log'
use '_\fIsuff\fR.log' as thesuffix for the log file. The default is '_bsim.log'
.
.\" -- --stack -----------------------------------
.IP \fB\-\-stack\ \fInnn\fR

48
tools/man/man1/tbw.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbw.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: tbw.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -8,7 +8,7 @@
.TH TBW 1 2016-10-02 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
tbw \- wrapper script to start ghdl based VHDL test benches
tbw \- wrapper script to start GHDL based VHDL test benches
.\" ------------------------------------------------------------------
.SH SYNOPSIS
.
@ -29,19 +29,19 @@ defined by the descriptor file \fItbw.dat\fP and the \fIFILEDEF\fP
arguments. Any additional options \fIGHDL-OPTIONS\fP are passed on to the test
bench executable.
.SS Backgroud
.SS Background
The VHDL implementation in \fBghdl\fP has no direct support for passing
command line arguments to the VHDL code. All test benches in the Retro
project use therefore fixed build-in generic file names. By convention
they refer to symlinks (see \fBsymlink\fP(7)) which are setup by
project use, therefore, fixed build-in generic file names. By convention,
they refer to symlinks (see \fBsymlink\fP(7)) which are set up by
\fBtbw\fP to point to a specific file prior to the execution of the
test bench.
.SS Default behaviour
In the simplest case \fBtbw\fP assumes a test bench with a single stimulus
.SS Default behavior
In the simplest case, \fBtbw\fP assumes a test bench with a single stimulus
file which is opened by convention as \'<TBPROG>_stim\'. The default
stimulus file is named \'<TBPROG>_stim.dat\'. \fBtbw\fP will simply
define \'<TBPROG>_stim\' as a symlink refering to \'<TBPROG>_stim.dat\',
define \'<TBPROG>_stim\' as a symlink referring to \'<TBPROG>_stim.dat\',
or if defined to \fIFILEDEF\fP, and execute \fITBPROG\fP. In essence
.EX
@ -53,16 +53,16 @@ or if defined to \fIFILEDEF\fP, and execute \fITBPROG\fP. In essence
When the generic file name or the stimulus file name does not follow the
simple default pattern or more than one input file is required a
configuration file can be used to define the setup. It has the fixed name
\fItbw.dat\fP and is searched the directory of the test bench program
\fItbw.dat\fP and is searched in the directory of the test bench program
\fITBPROG\fP.
The format is described in section FILES.
In this case the \fIFILEDEF\fP argument can be specified as 'tag=value'
In this case, the \fIFILEDEF\fP argument can be specified as 'tag=value'
pairs where tag refers to a generic name and value gives the concrete
file name. Useful when several input files are to be specified.
.
.SS Test benches controlled with \fBti_rri\fP
In this case the communication between test bench and the controlling
In this case, the communication between the test bench and the controlling
\fBti_rri\fP is done via two named pipes (see \fBfifo\fP(7)). The test
bench might open in addition a configuration file. This setup is also
defined via the \fItbw.dat\fP file, for details see section FILES.
@ -78,8 +78,8 @@ matching \fITBPROG\fP is found in tbw.dat.
Show the used tag,value settings before execution
.IP \fB\-norun\fR
Start simulator in interactive mode.
Default for _XSim or _ISim tb's is to ensure that the simulation runs till
the end, as for ghdl. Therefore a '-R' option for XSim or a 'run all' command
The default for _XSim or _ISim tb's is to ensure that the simulation runs till
the end, as for GHDL. Therefore a '-R' option for XSim or a 'run all' command
for ISim is generated. The -norun option suppresses this.
.\" ------------------------------------------------------------------
@ -91,8 +91,8 @@ with the "\fB\-\-help\fR" option. Some especially useful options are:
.\" ----------------------------------------------
.IP "\fB\-\-wave=\fIfile\fR"
dump signal values into a wave file (use file type .ghw). Far superior
to the VCD format and allows to inspect all VHDL records and all data types
with \fBgtkwave\fP(1).
to the VCD format and allows for inspecting all VHDL records and all data
types with \fBgtkwave\fP(1).
.
.\" ----------------------------------------------
.IP "\fB\-\-stack-max-size\fP=\fIn\fR"
@ -116,16 +116,16 @@ display process name before each cycle.
.
.SH ENVIRONMENT
.IP \fBTBW_GHDL_OPTS\fP 4
Additional options which are passed to ghdl based simulations.
Additional options which are passed to GHDL based simulations.
Of particular value are
.RS
.IP "\fB\-\-ieee\-asserts=disable\-at\-0\fP" 4
suppresses assertion warnings from the ieee libraries at startup time (t=0ns).
.IP "\fB\-\-unbuffered\fP"
sets output at all files (stdout, stderr, and files opened for write) to
unbuffered mode. This is very helpful to keep output from the ghdl
unbuffered mode. This is very helpful to keep output from the GHDL
simulation and other programs in a co-simulation environment in synch.
Note: only available for ghdl 0.34dev after merge of Jonsba/master #100 on
Note: only available for GHDL 0.34dev after merge of Jonsba/master #100 on
2016-06-26.
.RE
.
@ -156,10 +156,10 @@ refers to the given concrete file name. A typical example is
.IP "\fBUsage with test benches controlled with ti_rri\fR"
The special token \fI<fifo>\fP indicates that a named pipe is used
rather than a normal file. In this case \fBtbw\fP will create a
rather than a normal file. In this case, \fBtbw\fP will create a
\fBfifo\fP(7) rather than a symlink. Another special token is
\fI<null>\fP, it simply translates to \fI/dev/null\fP and can be
used as default value for configuration files. Currently all
used as a default value for configuration files. Currently, all
\fBrlink\fP based test benches use the same generic names and have
a setup like
@ -176,10 +176,10 @@ a setup like
.SH EXAMPLES
.SS Stimulus file based test benches
Test benches are usually self-checking and produce a comprehensive log file.
For each checked response the line contains the word \fICHECK\fP and either
an \fIOK\fP or a \fIFAIL\fP, in the later case in general with an indication
of whats wrong.
Other unexpected behaviour, like timeouts, will also result in a line
For each checked response, the line contains the word \fICHECK\fP and either
an \fIOK\fP or a \fIFAIL\fP, in the latter case in general with an indication
of what\'s wrong.
Other unexpected behavior, like timeouts, will also result in a line
containing the word \fIFAIL\fP.
When the simulation stops a line with the word \fIDONE\fP is printed.
These test benches are usually run like

28
tools/man/man1/ti_rri.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: ti_rri.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: ti_rri.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -21,7 +21,7 @@ ti_rri \- \fBRlink\fP Backend Server
.SH DESCRIPTION
The \fBti_rri\fP command creates a \fBtclsh\fP(1) based \fBRlink\fP backend
server session. After loading all basic packages and shared libraries which
implement the tcl binding of the \fBRlink\fP server the command
implement the Tcl binding of the \fBRlink\fP server the command
.RS 2
.PD 0
@ -29,7 +29,7 @@ implement the tcl binding of the \fBRlink\fP server the command
creates the default \fIrlc\fP and \fIrls\fP commands representing the connection
and the server objects
.IP "-"
loads additional tcl packages when requested with \fB\-\-pack\fP
loads additional Tcl packages when requested with \fB\-\-pack\fP
.IP "-"
sets up logging and debug according to \fB\-\-log\fP, \fB\-\-logl\fP,
\fB\-\-dmpl\fP, and \fB\-\-tiol\fP
@ -41,7 +41,7 @@ starts an additional process if requested with \fB\-\-run\fP
opens a connection when requested with \fB\-\-fifo\fP,
\fB\-\-term\fP, or \fB\-\-cuff\fP
.IP "-"
and finally executes all remaining \fICOMMANDS\fP arguments as tcl commands
and finally executes all remaining \fICOMMANDS\fP arguments as Tcl commands
.PD
.RE
.PP
@ -78,7 +78,7 @@ name prefix for the named pipe file names. Default is 'rlink_cext_fifo'.
Two fifo's are generated, one with a '_tx' and one with a '_tx' appended
to the name prefix.
.IP \fBopts\fP
comma separated list of further fifo port options:
comma-separated list of further fifo port options:
.RS
.PD 0
.IP \fBkeep\fP
@ -90,8 +90,8 @@ defer link initialization (debug or test benches)
.PD
.RE
Note: in general the default pipe names are used, thus \fIname\fP is almost
never specified. If only options are given an empty \fIname\fP field must be
Note: in general the default pipe names are used, thus \fIname\fP is rarely
specified. If only options are given an empty \fIname\fP field must be
specified like in \fB\-\-fifo=,xon\fP.
.RE
@ -103,7 +103,7 @@ open a serial port type \fBrlink\fP port. Optional arguments are
.IP \fBname\fP
tty device name, default is 'USB0'. If \fIname\fP does not start with '/'
the name is prefixed with '/dev/tty'. The special device name 'USBD'
triggers the auto-detection of a Digilent board with a FT2232C based
triggers the auto-detection of a Digilent board with an FT2232C based
interface.
.IP \fBbaud\fP
serial port baud rate, default is '115k'. Allowed baud rate settings are:
@ -122,7 +122,7 @@ serial port baud rate, default is '115k'. Allowed baud rate settings are:
.PD
.RE
.IP \fBopts\fP
comma separated list of further term port options:
comma-separated list of further term port options:
.RS
.PD 0
.IP \fBbreak\fP
@ -145,7 +145,7 @@ open a USB via Cypress FX2 type \fBrlink\fP port. Optional arguments are
USB path, default derived from environment variables RETRO_FX2_VID and
RETRO_FX2_PID.
.IP \fBopts\fP
comma separated list of further cuff port options:
comma-separated list of further cuff port options:
.RS
.PD 0
.IP \fBtrace\fP
@ -198,12 +198,12 @@ trace character activities
.\" -- --tout -----------------------------------
.IP \fB\-\-tout=\fIdt\fR
set connection timeout. Default is '1.'. Must be >0. . Should be set to a
larger value when slow simulators are connected, e.g. post-implentation
larger value when slow simulators are connected, e.g. post-implementation
timing models.
.
.\" -- --int ------------------------------------
.IP \fB\-\-int\fP
enter interactive mode even when further tcl commands are given on the
enter interactive mode even when further Tcl commands are given on the
\fBti_rri\fP command line.
.
.\" -- --help -----------------------------------
@ -212,7 +212,7 @@ print help text and exit
.
.\" -- -- ---------------------------------------
.IP \fB\-\-\fP
all following arguments are treated as tcl commands.
all following arguments are treated as Tcl commands.
.
.\" ------------------------------------------------------------------
.SH COMMANDS
@ -230,7 +230,7 @@ fifo communication for the test bench.
.IP "\fBti_rri --fifo=,xon --run='tbw tb_tst_rlink_arty'" 4
Like above, starts arty rather n4 test bench. The rlink is operated with
software flow control. Note the comma in front of \fIxon\fP, required to
ensure that default pipe name is used !
ensure that the default pipe name is used !
.\" ------------------------------------------------------------------
.SH "SEE ALSO"

20
tools/man/man1/ti_w11.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: ti_w11.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: ti_w11.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013-2019 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -39,9 +39,9 @@ use \fB\-\-cuff\fP connect (USB via Cypress FX2)
.IP \fB-t\fIDN\fR[,\fIopts\fP]
use \fB\-\-term\fP connect.
\fID\fP specifies device name. \fIN\fP specifies
the device number, or in case of the character 'D' the auto-detection of a
Digilent board with a FT2232C based interface.
\fIopts\fP specified the addtional options a \fB\-\-term\fP can hold
the device number, or in the case of the character 'D' the auto-detection of a
Digilent board with an FT2232C based interface.
\fIopts\fP specified the additional options a \fB\-\-term\fP can hold
(e.g. break or xon).
\fID\fP is mapped as
.RS
@ -53,7 +53,7 @@ use /dev/ttyUSB* (* is device number \fIN\fP or 'D')
.PD
.RE
.
.SS "setup options for ghdl simulation runs"
.SS "setup options for GHDL simulation runs"
.PD 0
.IP \fB-c7\fP
start \fItb_w11a_c7\fP simulation (Cmod A7, default \fB-fx\fP)
@ -103,7 +103,7 @@ use 2nd serport with switched xon
.IP \fB-tmu\fP
activate trace and monitoring unit
.IP \fB-ghw\fP
activate ghdl wave dump, will write a dump file with the name
activate GHDL wave dump, will write a dump file with the name
\fB<tb>.ghw\fR where <tb> is the filename of the test bench
.PD 0
.PD
@ -127,14 +127,14 @@ dry run, prints the commands but doesn't execute
.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBti_w11 -u @211bsd_rk_boot.tcl\fR" 4
Assumes a FPGA board with a \fBw11\fP CPU design already configured.
Assumes an FPGA board with a \fBw11\fP CPU design already configured.
Connected via USB, communication via Cypress FX2.
\fBti_rri\fP(1) will be started and the given boot script executed.
Typical way to start Nexys2 and Nexys3 boards.
The typical way to start Nexys2 and Nexys3 boards.
.IP "\fBti_w11 -tu2,12M,break,cts @211bsd_rl_boot.tcl\fR" 4
Assumes a FPGA board with a \fBw11\fP CPU design already configured.
Connected via USB, communication via an USB UART. In this case the
Assumes an FPGA board with a \fBw11\fP CPU design already configured.
Connected via USB, communication via a USB UART. In this case the
device \fI/dev/ttyUSB2\fP will be used, with \fI12 MBaud\fP, \fIbreak\fP to
trigger auto-bauding, and \fIcts\fP to use hardware handshake.
\fBti_rri\fP(1) will be started and the given boot script executed.

66
tools/man/man1/vbomconv.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: vbomconv.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: vbomconv.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2010-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -111,22 +111,22 @@ vbomconv \- generate files and actions from vbom manifest files
.\" --------------------------------------------------------
.SS Introduction
\fBvbomconv\fP is the central tool in a build system for
\fIvhdl\fP projects. Each \fIvhdl\fP source file has an associated
\fIVHDL\fP projects. Each \fIVHDL\fP source file has an associated
manifest file in \fBvbom\fP(5) format which contains a list of used
libraries and instantiated components, and the name of the
associated vhdl source file.
associated VHDL source file.
The instantiated components are defined via their \fBvbom\fP file.
All file names are relative to the current directory.
A recursive traversal through all \fBvbom\fP's
gives for each vhdl entity all the sources files needed to compile it,
gives for each VHDL entity all the sources files needed to compile it,
with duplicates removed and in proper compilation order, thus libraries first
and top level design last.
and top-level design last.
The \fBvbomconv\fP tool does this traversal of \fBvbom\fP
files and generates, depending on command line options, the files and/or
files and generates, depending on command line options, the files and/or
commands needed to run a synthesis tool or to build a simulation model.
Currently supported is synthesis with Xilinx ISE \fBxst\fP Xilinx Vivado
and simulation with \fBghdl\fP(1), Xilinx ISE \fBISim\fP or
Currently supported is synthesis with Xilinx ISE \fBxst\fP and Xilinx Vivado
and simulation with \fBghdl\fP(1), Xilinx ISE \fBISim\fP, or
Xilinx Vivado \fBxsim\fP.
\fBvbomconv\fP therefore currently generates
@ -146,12 +146,12 @@ dependency files
.PD
.PP
Key advantage of this approach is that the individual \fBvbom\fP
The key advantage of this approach is that the individual \fBvbom\fP
files are easy to maintain. They reflect the libraries and components used
in the vhdl source they describe, a structural change in the vhdl source
in the VHDL source they describe, a structural change in the VHDL source
usually implies an update of the vbom. The project files are automatically
generated from this 'local' information, which can be of great help in
projects with many top level designs which large number of entities in
projects with many top-level designs with a large number of entities in
different constellations.
\fBvbomconv\fP is usually embedded in a GNU \fBmake\fP(1) based build system.
@ -163,16 +163,16 @@ Some are given in the EXAMPLES section.
.\" --------------------------------------------------------
.SS Principle of Operation
\fBvbomconv\fP will start with processing the \fIvbom\fP
file given as argument.
file given as an argument.
Each file name extracted from a \fBvbom\fP is prepended with the directory
path of the \fBvbom\fP.
This ensures that all file names are relative to working directory under
This ensures that all file names are relative to the working directory under
which \fBvbomconv\fP was started, even though each \fBvbom\fP file holds
only file names which are relative to the \fBvbom\fP.
only file names that are relative to the \fBvbom\fP.
\fBvbomconv\fP expects that the entries in the \fBvbom\fP's
are ordered, libraries first, than the components in the order they are
instantiated, finally the name of the associated source file.
are ordered, libraries first, then the components in the order they are
instantiated, and finally the name of the associated source file.
Each \fI.vhd\fP file is added to a table of source files.
Each \fI.vbom\fP file is added to a list of \fBvbom\fP's
to be processed if it hasn't been processed yet.
@ -183,12 +183,12 @@ After all \fBvbom\fP's
are processed a ranking algorithm will generate an ordered list of source
files in proper compilation order. This ensures that libraries are compiled
before a source refers to them with a '\fIuse\fP' clause, and that entities
are compiled before they are refered to by an explicit instatiation.
are compiled before they are referred to by an explicit instatiation.
The \fBvbom\fP file format supports conditional inclusion of files via a
condition prefix.
The main purpose of this mechanism is to handle libraries and components
which are only refered in
which are only referred in
.EX
-- synthesis translate_off
-- synthesis translate_on
@ -196,7 +196,7 @@ which are only refered in
sections and are used only for simulation.
The \fBvbom\fP file format has a logical name mechanism to support the
\fIconfiguration\fP mechanism of vhdl. A logical name can be defined with
\fIconfiguration\fP mechanism of VHDL. A logical name can be defined with
.EX
<lname> = <filename>
.EE
@ -213,7 +213,7 @@ Last but not least are 5 directives defined in the \fBvbom\fP
file format:
.
.IP "\fB@top\fP:\fIname\fP"
allows to specify the top level design name in case it differs from the
allows to specify the top-level design name in case it differs from the
stem of the \fIvbom\fP file name.
.
.IP "\fB@lib\fP:\fIname\fP"
@ -227,7 +227,7 @@ be included in the constraints fileset.
.
.IP "\fB@tcl\fP:\fIfile\fP"
specifies that \fIfile\fP is a Tcl script to be executed when building
the vivado project. The Tcl script generated by \fB\-\-vsyn_prj\fP
the Vivado project. The Tcl script generated by \fB\-\-vsyn_prj\fP
will contain statements with source \fIfile\fP.
.
.IP "\fB@ucf_cpp\fP:\fIfile\fP"
@ -246,7 +246,7 @@ The \fBvbomconv\fP command has the form
.RI [ action ]
.I vbom
.PP
and must be called, with the exception of the \fB\-\-help\fP case, with
and must be called, except for the \fB\-\-help\fP case, with
exactly one \fIvbom\fP file.
.
.\" --------------------------------------------------------
@ -291,7 +291,7 @@ one not requiring a \fIvbom\fP file.
.B \-\-dep_vsim
These four actions write to \fIstdout\fP dependency rules for inclusion in
\fIMakefile\fPs.
Together with an appropruate pattern rule they allow to automatitize
Together with an appropriate pattern rule, they allow to automatize
the dependency handling, see the EXAMPLES section for practical usage.
\fB\-\-dep_ghdl\fP creates the dependencies for \fBghdl\fP
@ -392,7 +392,7 @@ The \fB\-\-ghdl_m\fP action immediately executes this command via
.B \-\-isim_prj
These two actions write to \fIstdout\fP a project file suitable for ISE
\fBxst\fP or \fBISim\fP, respectively.
The vhdl source files are in proper compilation order. See
The VHDL source files are in proper compilation order. See
the EXAMPLES section for practical usage in a make flow.
.
.\" ----------------------------------------------
@ -400,7 +400,7 @@ the EXAMPLES section for practical usage in a make flow.
.B \-\-vsyn_prj
This action writes to \fIstdout\fP a Tcl script suitable as project definition
for Vivado synthesis. This script is source'ed or eval'ed and defines the
source fileset and the constraints fileset. The vhdl source files are in
source fileset and the constraints fileset. The VHDL source files are in
proper compilation order.
.
.\" ----------------------------------------------
@ -421,7 +421,7 @@ simulation.
.BI \-\-xst_export \fR=\fPpath
.TQ
.BI \-\-isim_export \fR=\fPpath
These actions create a flat copy of all source files needed for a
These actions create a flat copy of all source files needed for an
\fBxst\fP synthesis or a \fBghdl\fP or \fBISim\fP
simulation model in the directory \fIpath\fP.
The sub directory structure is lost, all files will be in directory
@ -429,7 +429,7 @@ The sub directory structure is lost, all files will be in directory
.
.\" ----------------------------------------------
.IP \fB\-\-get_top\fP
Returns the top level entity name to \fIstdout\fP.
Returns the top-level entity name to \fIstdout\fP.
Is by default the stem of the \fIvbom\fP file name, or given by a
\fB@top\fP directive picked up during \fBvbom\fP traversal.
.
@ -437,9 +437,9 @@ Is by default the stem of the \fIvbom\fP file name, or given by a
.IP \fB\-\-flist\fP
Write an alphabetically sorted list of all source and vbom files to
\fIstdout\fP.
This information is for example helpful to build a project export tool.
This information for example helps to build a project export tool.
Note that in contrast to most other actions the files are not in compilation
but in alphabetic order, and that also the \fBvbom\fP files are included
but alphabetic order, and that also the \fBvbom\fP files are included
in this list.
.
.\" ------------------------------------------------------------------
@ -456,10 +456,10 @@ In these cases the caller will see the exit status of \fBghdl\fP.
.SH ENVIRONMENT
.IP \fBVBOMCONV_XSIM_LANG\fP 4
Controls the language for the generated models used by xsim. Can be set to
\fIverilog\fP or to \fIvhdl\fP. If not defined \fIverilog\fP is used.
\fIVerilog\fP or \fIVHDL\fP. If not defined \fIVerilog\fP is used.
It affects \fB\-\-vsim_prj\fP but also \fB\-\-dep_vsim\fP.
Use \fBrm_dep\fP(1) to force regeneration of dependency files when this
environment variable is set, unset or changed.
environment variable is set, unset, or changed.
.
.IP \fBVBOMCONV_GHDL_OPTS\fP
Extra options for the ghdl compile stage. If not specified "\fB-O2 -g\fP" is
@ -498,7 +498,7 @@ via
The synthesis and simulation tools will react with sometimes hard to
trace error messages.
.br
To avoid this problem ensure that building of the relative paths
To avoid this problem ensure that the building of the relative paths
is always done with the minimal number of \fI../\fP to reach the file.
.
.IP \(bu 2
@ -530,7 +530,7 @@ files and include them. In case they don't yet exist or are out of date
.EE
.PP
After renames and deletions of source files the dependency rule files can have
dangling entries which cause 'No rule to make target' errors. In that case
dangling entries which cause 'No rule to make target' errors. In that case,
just delete all '.dep_*' files. The script \fBrm_dep\fP(1)
will do that recursively for a whole directory tree.
.

14
tools/man/man1/xise_ghdl_simprim.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xise_ghdl_simprim.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: xise_ghdl_simprim.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2010-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -8,7 +8,7 @@
.TH XISE_GHDL_SIMPRIM 1 2016-07-02 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
xise_ghdl_simprim \- compile Xilinx ISE SIMPRIM libraries for ghdl
xise_ghdl_simprim \- compile Xilinx ISE SIMPRIM libraries for GHDL
.\" ------------------------------------------------------------------
.SH SYNOPSIS
.
@ -26,7 +26,7 @@ tree of the currently active version of ISE/WebPack under
Since direct calls to ISE tools are in general encapsulated with \fBxtwi\fP(1)
the \fI$XTWI_PATH\fP is used instead of \fI$XILINX\fP.
This allows to use this script and \fBghdl\fP without a \fBxtwi\fP wrapper.
This allows using this script and \fBghdl\fP without an \fBxtwi\fP wrapper.
Just use the \fBghdl\fP option
@ -36,14 +36,14 @@ Just use the \fBghdl\fP option
to link to the SIMPRIM library.
Up to ISE 10 the VITAL models were all concatinated in one large file
Up to ISE 10 the VITAL models were all concatenated in one large file
\fIsimprim_VITAL.vhd\fP.
In this case the \fBxilinx_vhdl_chop\fP
helper script will create individual source files for each model.
For ISE 11 and later the modules are shipped as separate files.
The Xilinx source code has since many releases some buggy statements with
self-referencial initializations. They seem to be tolerated by the commercial
self-referential initializations. They seem to be tolerated by the commercial
tools but not by \fBghdl\fP.
The \fBxilinx_vhdl_memcolltype_fix\fP
helper script simply removes them, no further problems seen so far.
@ -51,7 +51,7 @@ helper script simply removes them, no further problems seen so far.
.\" ------------------------------------------------------------------
.SH OPTIONS
Options added after the xise_ghdl_simprim command are simply forwarded to
the 'ghdl -a' commands. In general used to specify the optimize level.
the 'ghdl -a' commands. In general, used to specify the optimize level.
If no options given \fI-O2 -g\fP is used.
.\" ------------------------------------------------------------------
@ -62,7 +62,7 @@ points to the root of the currently active ISE/WebPack installation.
.\" ------------------------------------------------------------------
.SH FILES
.IP \fI$XTWI_PATH/ISE_DS/ISE/vhdl/src/simprims\fP
The vhdl sources for the SIMPRIM library are looked for in this directory tree.
The VHDL sources for the SIMPRIM library are looked for in this directory tree.
.IP \fI$XTWI_PATH/ISE_DS/ISE/ghdl/simprim\fP
The created object files will be written into this directory. The directory
is created if not yet existing. Note that the \fI$XTWI_PATH\fP

14
tools/man/man1/xise_ghdl_unisim.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xise_ghdl_unisim.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: xise_ghdl_unisim.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2010-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -8,7 +8,7 @@
.TH XISE_GHDL_UNISIM 1 2016-07-02 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
xise_ghdl_unisim \- compile Xilinx ISE UNISIM and UNIMACRO libraries for ghdl
xise_ghdl_unisim \- compile Xilinx ISE UNISIM and UNIMACRO libraries for GHDL
.\" ------------------------------------------------------------------
.SH SYNOPSIS
.
@ -25,7 +25,7 @@ ISE under \fI$XILINX/ghdl/unisim\fP and \fI$XILINX/ghdl/unimacro\fP.
Since direct calls to ISE tools are in general encapsulated with \fBxtwi\fP(1)
the \fI$XTWI_PATH\fP is used instead of \fI$XILINX\fP.
This allows to use this script and \fBghdl\fP without a \fBxtwi\fP wrapper.
This allows using this script and \fBghdl\fP without an \fBxtwi\fP wrapper.
Just use the \fBghdl\fP option
@ -37,7 +37,7 @@ Just use the \fBghdl\fP option
to link to the UNISIM or UNIMACRO library.
The Xilinx source code has since many releases some buggy statements with
self-referencial initializations. They seem to be tolerated by the commercial
self-referential initializations. They seem to be tolerated by the commercial
tools but not by \fBghdl\fP.
The \fBxilinx_vhdl_memcolltype_fix\fP
helper script simply removes them, no further problems seen so far.
@ -45,7 +45,7 @@ helper script simply removes them, no further problems seen so far.
.\" ------------------------------------------------------------------
.SH OPTIONS
Options added after the xise_ghdl_unisim command are simply forwarded to
the 'ghdl -a' commands. In general used to specify the optimize level.
the 'ghdl -a' commands. In general, used to specify the optimize level.
If no options given \fI-O2 -g\fP is used.
.\" ------------------------------------------------------------------
@ -56,9 +56,9 @@ points to the root of the currently active ISE installation.
.\" ------------------------------------------------------------------
.SH FILES
.IP \fI$XTWI_PATH/ISE_DS/ISE/vhdl/src/unisims\fP
The vhdl sources for the Xilinx ISE UNISIM library
The VHDL sources for the Xilinx ISE UNISIM library
.IP \fI$XTWI_PATH/ISE_DS/ISE/vhdl/src/unimacro\fP
The vhdl sources for the Xilinx ISE UNIMACRO library
The VHDL sources for the Xilinx ISE UNIMACRO library
.IP \fI$XTWI_PATH/ISE_DS/ISE/ghdl\fP
The created object files will be written into this directory. The directory
is created if not yet existing. Note that the \fI$XTWI_PATH\fP

14
tools/man/man1/xise_msg_filter.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xise_msg_filter.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: xise_msg_filter.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2014-2015 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -24,11 +24,11 @@ xise_msg_filter \- message filter for Xilinx ISE tool chain log files
.\" ------------------------------------------------------------------
.SH DESCRIPTION
.\" ----------------------------------------------
Scans the log file \fILOGFILE\fP generated by Xilinx ISE tool specified
by \fITYPE\fP for informational, warning and error messages and compares
Scans the log file \fILOGFILE\fP generated by the Xilinx ISE tool specified
by \fITYPE\fP for informational, warning, and error messages and compares
these messages against a set of message filter rules defined in the
\fIIMFSET\fP file.
xise_msg_filter will print all no-matching messages.
xise_msg_filter will print all non-matching messages.
All filter rules which do not match a message are also listed, these
messages are considered missing.
Matched messages are considered accepted.
@ -72,7 +72,7 @@ print full help.
Simply a list of regular expression patterns structured by section headers
of the form "[TYPE]".
Blank lines and lines starting with '#' will be ignored.
xise_msg_filter will extract the patters of the section matching the
xise_msg_filter will extract the patterns of the section matching the
\fITYPE\fP argument.
.SS Example message filter file
.EX
@ -96,8 +96,8 @@ Generate a short summary of a ISE xst log file.
.
.\" ------------------------------------------------------------------
.SH "BUGS"
The \fIIMFSET\fP file is flat, no structuring possible, e.g. with includes.
It be great to have for example default rules for each target device.
The \fIIMFSET\fP file is flat, with no structuring possible, e.g. with includes.
It\'ll be great to have for example default rules for each target device.
Since ISE is 'end-of-life' no further work on xise_msg_filter will be done.
.
.\" ------------------------------------------------------------------

8
tools/man/man1/xtwi.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xtwi.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: xtwi.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2014-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -23,7 +23,7 @@ tools run fine in this environment, but other installed programs on the
system can (and actually do) fail. \fBxtwi\fP helps to keep the ISE
environment separate from the normal working environment.
The environment variable XTWI_PATH must be setup to the install path
The environment variable XTWI_PATH must be set up to the install path
of the ISE version to be used. Without the /ISE_DS/ which is added
by the ISE installation procedure.
@ -31,7 +31,7 @@ by the ISE installation procedure.
and execs the \fICOMMAND\fP. This way \fICOMMAND\fP is executed in the
ISE environment, while the login shell stays clean.
\fBxtwi\fP can also setup a clean environment when BARE_PATH and
\fBxtwi\fP can also set up a clean environment when BARE_PATH and
BARE_LD_LIBRARY_PATH are defined.
.
@ -69,7 +69,7 @@ ISE setup script located and sourced on 32 or 64 bit systems
.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBxtwi netgen -sim -intstyle xflow -ofmt vhdl -w test.ngc" 4
Starts the ISE netlister and generates a vhdl model from \fItest.ngc\fP.
Starts the ISE netlister and generates a VHDL model from \fItest.ngc\fP.
.
.\" ------------------------------------------------------------------
.SH "NOTES"

10
tools/man/man1/xtwv.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xtwv.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: xtwv.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2014-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -23,14 +23,14 @@ The Vivado tools run fine in this environment, but other installed programs
on the system might fail. \fBxtwv\fP helps to keep the Vivado environment
separate from the normal working environment.
The environment variable XTWV_PATH must be setup to the install path
The environment variable XTWV_PATH must be set up to the install path
of the Vivado version to be used.
\fBxtwv\fP uses XTWV_PATH to locate the Vivado setup script, sources it,
and execs the \fICOMMAND\fP. This way \fICOMMAND\fP is executed in the
Vivado environment, while the login shell stays clean.
\fBxtwi\fP can also setup a clean environment when BARE_PATH and
\fBxtwi\fP can also set up a clean environment when BARE_PATH and
BARE_LD_LIBRARY_PATH are defined.
.
@ -68,11 +68,11 @@ Vivado setup script located and sourced on 32 or 64 bit systems
.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBxtwv vivado -mode batch -source test.tcl" 4
Starts vivado in batch mode and executes the script \fItest.tcl\fP.
Starts Vivado in batch mode and executes the script \fItest.tcl\fP.
.
.\" ------------------------------------------------------------------
.SH "NOTES"
Vivado is a lot less intrusive as ISE, but it's still a good precaution to
Vivado is a lot less intrusive than ISE, but it's still a good precaution to
wrap calls of Vivado tools with \fBxtwv\fP.
.br
If both Vivado and ISE are used \fBxtwv\fP and \fBxtwi\fP(1) offer a convenient

12
tools/man/man1/xviv_ghdl_unisim.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xviv_ghdl_unisim.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: xviv_ghdl_unisim.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2015-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -8,7 +8,7 @@
.TH XVIV_GHDL_UNISIM 1 2016-07-02 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
xviv_ghdl_unisim \- compile Xilinx Vivado UNISIM and UNIMACRO libraries for ghdl
xviv_ghdl_unisim \- compile Xilinx Vivado UNISIM and UNIMACRO libraries for GHDL
.\" ------------------------------------------------------------------
.SH SYNOPSIS
.
@ -23,7 +23,7 @@ libraries for \fBghdl\fP. The object files generated by \fBghdl\fP
are stored in the directory tree of the currently active version of
Vivado under \fI$XTWV_PATH/ghdl/unisim\fP and \fI$XTWV_PATH/ghdl/unimacro\fP.
This script build the 'retarget' version of UNISIM, thus most legacy entities
This script builds the 'retarget' version of UNISIM, thus most legacy entities
from the ISE UNISIM library are available and will be mapped to the matching
Series-7 entities.
@ -38,7 +38,7 @@ to link to the UNISIM or UNIMACRO library.
\fBghdl\fP can be used without a \fBxtwv\fP wrapper.
The Xilinx source code has since many releases some buggy statements with
self-referencial initializations. They seem to be tolerated by the commercial
self-referential initializations. They seem to be tolerated by the commercial
tools but not by \fBghdl\fP.
The \fBxilinx_vhdl_memcolltype_fix\fP
helper script simply removes them, no further problems seen so far.
@ -57,9 +57,9 @@ points to the root of the currently active Vivado installation.
.\" ------------------------------------------------------------------
.SH FILES
.IP \fI$XTWV_PATH/data/vhdl/src/unisims\fP
The vhdl sources for the Xilinx Vivado UNISIM library
The VHDL sources for the Xilinx Vivado UNISIM library
.IP \fI$XTWV_PATH/data/vhdl/src/unimacro\fP
The vhdl sources for the Xilinx Vivado UNIMACRO library
The VHDL sources for the Xilinx Vivado UNIMACRO library
.IP \fI$XTWV_PATH/ghdl\fP
The created object files will be written into this directory. The directory
is created if not yet existing. Note that the \fI$XTWV_PATH\fP

14
tools/man/man1/xviv_msg_filter.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xviv_msg_filter.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: xviv_msg_filter.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -27,11 +27,11 @@ xviv_msg_filter \- message filter for Xilinx Vivado tool chain log files
Scans the log file \fILOGFILE\fP generated by Xilinx Vivado for messages and
compares these messages against a set of message filter rules defined in the
\fIVMFSET\fP file and selected by \fITYPE\fP.
xviv_msg_filter will print all no-matching messages.
xviv_msg_filter will print all non-matching messages.
All filter rules which do not match a message are also listed, these
messages are considered missing.
Matched messages are considered accepted.
In normal operation they will not create output.
In normal operation, they will not create output.
xviv_msg_filter is useful for example in \fBmake\fP(1) based flows to
create a short summary from the log files.
@ -66,7 +66,7 @@ print full help.
.SH MESSAGE FILTER FILE FORMAT
.\" ----------------------------------------------
Simply a list of match rules structured by section headers
of the form "[TYPE]". '#' is interpreted as comment delimiter, everything
of the form "[TYPE]". '#' is interpreted as a comment delimiter, everything
after a '#' in a line will be ignored.
xviv_msg_filter will extract the rules of the section matching the
\fITYPE\fP argument.
@ -78,8 +78,8 @@ A line of the form
{yyyy.n:}
{:}
.EE
acts as version range tag and specifies a range of Vivado versions for which the
following rules shall be applied.
acts as a version range tag and specifies a range of Vivado versions for which
the following rules shall be applied.
"{:2016.4}" means up to version 2016.4, "{:2017.1}" from 2017.1 on, while
"{:}" cancels version range checking.
@ -105,7 +105,7 @@ notification is printed.
matching messages are counted, only a summary of the message counts is
printed.
.IP \fBr\fP 4
signals that at least one matching message is required, if none seen, a
signals that at least one matching message is required, if none is seen, a
notification is printed.
.PD
.RE

10
tools/man/man1/xviv_sim_vhdl_cleanup.1
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xviv_sim_vhdl_cleanup.1 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: xviv_sim_vhdl_cleanup.1 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -7,7 +7,7 @@
.TH XVIV_SIM_VHDL_CLEANUP 1 2016-06-05 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
xviv_sim_vhdl_cleanup \- cleanup Vivado generated vhdl for ghdl
xviv_sim_vhdl_cleanup \- cleanup Vivado generated VHDL for GHDL
.\" ------------------------------------------------------------------
.SH SYNOPSIS
.
@ -18,10 +18,10 @@ xviv_sim_vhdl_cleanup \- cleanup Vivado generated vhdl for ghdl
.\" ------------------------------------------------------------------
.SH DESCRIPTION
.\" ----------------------------------------------
The Vivado \fIwrite_vhdl\fP command generates code which violates a vhdl
The Vivado \fIwrite_vhdl\fP command generates code that violates a VHDL
language rule.
Attributes of port signals are declared in the architecture, but should be in
the entiry declaration. xsim and other simulators accept this, but
Attributes of port signals are declared in the architecture but should be in
the entity declaration. xsim and other simulators accept this, but
\fBghdl\fP(1) doesn't. This script simply filters out lines like
.EX
attribute .... RTL_KEEP

61
tools/man/man5/vbom.5
View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: vbom.5 1188 2019-07-13 14:31:51Z mueller $
.\" $Id: vbom.5 1231 2022-04-28 08:40:50Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2010-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -12,27 +12,28 @@ vbom \- vhdl manifest file format - 'vhdl bill of material'
.
.\" ------------------------------------------------------------------
.SH DESCRIPTION
\fBvbom\fP files describe the sources needed to build a \fIvhdl\fP
entity. The source files are either given directly in case of libraries
or via other \fBvbom\fP's in case of instantiated components.
\fBvbom\fP files describe the sources needed to build a \fIVHDL\fP
entity. The source files are either given directly in the case of libraries
or via other \fBvbom\fP's in the case of instantiated components.
They are used by \fBvbomconv\fP(1) to build project descriptions
for synthesis and simulation tools.
\fBvbomconv\fP expects that the entries in the \fBvbom\fP's
are ordered, libraries first, than the components in the order they are
instantiated, finally the name of the associated source file.
are ordered, libraries first, then the components in the order they are
instantiated, and finally the name of the associated source file.
The format has five types of lines:
.
.\" ----------------------------------------------
.IP \fBComments\fP 4
Each line starting with '\fB#\fP' is treated as comment and ignored.
Each line starting with '\fB#\fP' is treated as a comment and ignored.
.
.\" ----------------------------------------------
.IP "\fBFile names\fP"
Either source files or nested \fBvbom\fP's. The file names must be given
as relative path name from the directory the \fBvbom\fP file is located in.
Absolute path names are not allowed, nor is expansion of environment variables.
as relative path names from the directory the \fBvbom\fP file is located in.
Absolute path names are not allowed, nor is an expansion of environment
variables.
Currently the following file types are accepted:
.RS
@ -40,23 +41,23 @@ Currently the following file types are accepted:
refers to a nested \fBvbom\fP. Usually used for instantiated components.
.
.IP "\fB.vhd\fP"
refers to a source file. Usually used for libraries refered to in 'use'
clauses, and as last file, the source file of the entity which is
refers to a source file. Usually used for libraries referred to in 'use'
clauses, and as the last file, the source file of the entity which is
described by this \fBvbom\fP file.
.
.TP
.B "\fB.v\fP"
.TQ
.B "\fB.sv\fP"
refers to a verilog or system verilog source file. Accepted by the vivado
refers to a Verilog or System Verilog source file. Accepted by the Vivado
xsim simulator. Typically used for DPI wrappers or simprim based models
in vivado.
in Vivado.
.
.IP "\fB.c\fP"
refers to the C sources which implement either a vhdl function or
procedure via the VHPI mechanism or a system verilog functions
via the DPI mechanism. Supported only in conjunction with ghdl
and vivado simulator.
refers to the C sources which implement either a VHDL function or
procedure via the VHPI mechanism or a System Verilog function
via the DPI mechanism. Supported only in conjunction with GHDL
and Vivado simulator.
.
.RE
.
@ -66,7 +67,7 @@ File names can be followed by a list of attributes of the form
.EX
-\fIname\fP[:\fIvalue\fP] ...
.EE
Currently the following attributes are recognized
Currently, the following attributes are recognized
.RS
.IP "\fB-UUT\fP" 6
Signals that the \fIvbom\fP descibes a test bench and that file is
@ -77,14 +78,14 @@ name of a generated model for a functional or timing simulation.
.
.IP "\fB-SCOPE_REF[:\fIentity\fP]\fP" 6
Signals that the xdc file should be 'scoped to reference' to \fIentity\fP.
If \fIentity\fP is omitted the filename is taken as entity name.
If \fIentity\fP is omitted the filename is taken as the entity name.
In general used together with the \fB@xdc:\fP directive.
.
.RE
.
.\" ----------------------------------------------
.IP "\fBConditional file names\fP"
File names can be preceeded by a condition prefix of the form
File names can be preceded by a condition prefix of the form
.EX
[\fItag\fP]filename
@ -92,19 +93,19 @@ File names can be preceeded by a condition prefix of the form
.EE
The main purpose of this mechanism is to handle libraries and components
which are only refered in
which are only referred in
.EX
-- synthesis translate_off
-- synthesis translate_on
.EE
sections and are used only for simulation.
Currently supported \fItag\fP names are
Currently, supported \fItag\fP names are
.RS
.RS 3
.PD 0
.IP "\fBghdl\fP" 6
included in conjunction with ghdl simulation
included in conjunction with GHDL simulation
.IP "\fBviv\fP" 6
included in conjunction with Vivado targets
.IP "\fBvsyn\fP" 6
@ -137,8 +138,8 @@ A logical name can be used with
${\fIlname\fP}
${\fIlname\fP := \fIdefault\fP}
.EE
In the first form \fIlname\fP must have been defined before.
The second form allows to specify a \fIdefault\fP which is used when
In the first form, \fIlname\fP must have been defined before.
The second form allows specifying a \fIdefault\fP which is used when
\fIlname\fP hasn't been defined so far.
Again, the filenames must be given as relative path name from the directory
@ -154,7 +155,7 @@ from the stem of the \fBvbom\fP file name.
.
.IP "\fB@lib\fP:\fIname\fP"
Specifies an additional system library. Allowed values for \fIname\fP are
\fIunisim\fP, \fIunimacro\fP and \fIsimprim\fP.
\fIunisim\fP, \fIunimacro\fP, and \fIsimprim\fP.
Currently used to generate the appropriate -L options for \fBghdl\fP commands,
e.g. generated by the \fBvbomconv\fP action \fB\-\-ghdl_m\fP.
.
@ -164,18 +165,18 @@ be included in the constraints fileset.
.
.IP "\fB@tcl\fP:\fIfile\fP"
specifies that \fIfile\fP is a Tcl script to be executed when building
the vivado project. The Tcl script generated by the \fBvbomconv\fP action
the Vivado project. The Tcl script generated by the \fBvbomconv\fP action
\fB\-\-vsyn_prj\fP will contain statements with source \fIfile\fP.
.
.IP "\fB@ucf_cpp\fP:\fIfile\fP"
Specifies that a \fIfile\fP.ucf file is to be generated by \fBcpp\fP(1)
from a \fIfile\fP.ucf_cpp source file. This allows to modularize ISE ucf files.
from a \fIfile\fP.ucf_cpp source file. This allows modularizing ISE ucf files.
.RE
.
.\" ------------------------------------------------------------------
.SH EXAMPLES
.SS Simple entity
A simple vhdl entity named \fIbp_2l4l\fP which is defined in the source
A simple VHDL entity named \fIbp_2l4l\fP which is defined in the source
file \fIbp_2l4l.vhd\fP, which uses the library \fIslvtypes\fP and
instantiates \fIbp_2line\fP and \fIbp_4line\fP, might have a
\fIbp_2l4l.vbom\fP like
@ -190,7 +191,7 @@ instantiates \fIbp_2line\fP and \fIbp_4line\fP, might have a
bp_2l4l.vhd
.EE
.PP
Note that the vhdl source file \fIbp_2l4l.vhd\fP is always given in the
Note that the VHDL source file \fIbp_2l4l.vhd\fP is always given in the
\fBvbom\fP file which describes this source file.
The comments are put in by convention to help the human reader and
are not interpreted by \fBvbomconv\fP.