diff --git a/doc/CHANGELOG-w11a_V0.70-w11a_V0.74.md b/doc/CHANGELOG-w11a_V0.70-w11a_V0.74.md index 7d13e93b..a9114117 100644 --- a/doc/CHANGELOG-w11a_V0.70-w11a_V0.74.md +++ b/doc/CHANGELOG-w11a_V0.70-w11a_V0.74.md @@ -198,7 +198,7 @@ are currently disabled for Artix based systems (see issue V0.73-3). - memory inference is now used for all distributed and block rams under Vivado. The memory generators in memlib are still used under ISE - Note: they were initially setup to work around ISE synthesis issues. + Note: they were initially set up to work around ISE synthesis issues. - Vivado synthesis and implementation use now 'explore' type flows for optimal timing performance. - the two clock dram based fifo was re-written (as `fifo_2c_dram2`) to allow diff --git a/doc/INSTALL.md b/doc/INSTALL.md index b5c52cb0..b4fb9675 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -4,11 +4,11 @@ - [Download](#user-content-download) - [System requirements](#user-content-sysreq) -- [Setup environment variables](#user-content-envvar) +- [Set up environment variables](#user-content-envvar) - [Compile UNISIM/UNIMACRO/SIMPRIM libraries for GHDL](#user-content-ghdl-lib) - [Compile and install the support software](#user-content-build-tools) - [Compile sharable libraries](#user-content-build-cpp) - - [Setup Tcl packages](#user-content-build-tcl) + - [Set up Tcl packages](#user-content-build-tcl) - [The build system](#user-content-build-system) - [Available designs](#user-content-build-fpga) - [Available bitkits with bit and log files](#user-content-bitkits) @@ -80,7 +80,7 @@ distributions should be straightforward. required, version 1.8.3.1 or later. -### Setup environment variables +### Set up environment variables The `make` flows for building test benches (GHDL, Vivado xsim or ISE ISim based) and FPGA bit files (with Vivado or ISE), as well as the support software @@ -116,7 +116,7 @@ the distribution will work, in those cases simply use export TCLINC=/usr/include/tcl8.6 export TCLLIBNAME=tcl8.6 -and don't setup `BOOSTINC` and `BOOSTLIB`. +and don't set up `BOOSTINC` and `BOOSTLIB`. After that building functional model based test benches will work. If you want to also build post-synthesis or post-place&route test benches @@ -173,7 +173,7 @@ To cleanup, e.g. before a re-build rm_dep make realclean -#### Setup Tcl environment +#### Set up Tcl environment The Tcl files are organized in several packages. To create the Tcl package files (`pkgIndex.tcl`) diff --git a/doc/INSTALL_fx2_support.md b/doc/INSTALL_fx2_support.md index 8bc623b5..af03139f 100644 --- a/doc/INSTALL_fx2_support.md +++ b/doc/INSTALL_fx2_support.md @@ -8,8 +8,8 @@ installation of tools, environment setup and generation of the FX2 firmware. ### Table of content - [System requirements](#user-content-sysreq) -- [Setup environment variables](#user-content-envvar) -- [Setup USB access](#user-content-usb-access) +- [Set up environment variables](#user-content-envvar) +- [Set up USB access](#user-content-usb-access) - [Rebuild Cypress FX2 firmware](#user-content-fx2-firmware) ### System requirements @@ -23,7 +23,7 @@ USB Interface. Re-building them requires is **broken in Ubuntu 16.04**. See [INSTALL_urjtag.md](INSTALL_urjtag.md) for installation from sources !! -### Setup environment variables +### Set up environment variables The default USB VID and PID is defined by two environment variables. For internal lab use one can use @@ -36,10 +36,10 @@ For internal lab use one can use > misuse of the defaults provided with the project sources. > Usage of this VID/PID in any commercial product is forbidden.** -### Setup USB access +### Set up USB access For using the Cypress FX2 USB interface on Digilent Nexys2 and Nexys3 -boards `udev` rules must be setup to allow user level access to +boards `udev` rules must be set up to allow user level access to these devices. A set of rules is provided under $RETROBASE/tools/fx2/sys diff --git a/doc/INSTALL_quickstart.md b/doc/INSTALL_quickstart.md index ee21bd98..236664ee 100644 --- a/doc/INSTALL_quickstart.md +++ b/doc/INSTALL_quickstart.md @@ -26,7 +26,7 @@ First all required software must be installed see [INSTALL#sysreq](INSTALL.md#user-content-sysreq), and that Xilinx Vivado is installed. -- setup the shell environment, +- set up the shell environment, see [INSTALL#envvar](INSTALL.md#user-content-envvar), export RETROBASE= @@ -38,14 +38,14 @@ First all required software must be installed export XTWV_PATH= - setup the TCL environment, + set up the TCL environment, see [INSTALL#build-tcl](INSTALL.md#user-content-build-tcl) cd $HOME ln -s $RETROBASE/tools/tcl/.tclshrc . ln -s $RETROBASE/tools/tcl/.wishrc . - and ensure that USB `udev` rules for access and latency are setup, + and ensure that USB `udev` rules for access and latency are set up, see [tools/sys/README](../tools/sys/README.md). - compile the backend software tools @@ -94,7 +94,7 @@ Key steps are - consult the README in the oskit directory and download the disk image files, typically with a `wget` and `tar` command -- setup `vt100` emulator windows +- set up `vt100` emulator windows cd $RETROBASE/tools/oskit/ console_starter -d DL0 & diff --git a/doc/INSTALL_simh.md b/doc/INSTALL_simh.md index 3a488ba6..2279ab48 100644 --- a/doc/INSTALL_simh.md +++ b/doc/INSTALL_simh.md @@ -50,7 +50,7 @@ The post [Announcing the Open SIMH project](https://groups.io/g/simh/topic/91528716) announed on 2022-06-03 a re-launch of SimH as FOSS project. A new repository [open-simh/simh](https://github.com/open-simh/simh#readme) -was setup and provides the SimH code-base under an +has been set up and provides the SimH code-base under an [MIT-style licence](https://en.wikipedia.org/wiki/MIT_License), see [LICENSE.txt](https://github.com/open-simh/simh/blob/master/LICENSE.txt). diff --git a/doc/README_buildsystem_ISE.md b/doc/README_buildsystem_ISE.md index 0db10fd7..5c2a4e2c 100644 --- a/doc/README_buildsystem_ISE.md +++ b/doc/README_buildsystem_ISE.md @@ -3,8 +3,8 @@ ### Table of content - [Concept](#user-content-concept) -- [Setup system environment](#user-content-sysenv) - - [Setup environment variables](#user-content-envvar) +- [Set up system environment](#user-content-sysenv) + - [Set up environment variables](#user-content-envvar) - [Compile UNISIM/UNIMACRO/SIMPRIM libraries for GHDL](#user-content-ghdllibs) - [Building test benches](#user-content-buildtb) - [With GHDL](#user-content-buildtb-ghdl) @@ -58,9 +58,9 @@ maintained. For more details on vbomconv consult the man page. -### Setup system environment +### Set up system environment -#### Setup environment variables +#### Set up environment variables The build flows require the environment variables: - `RETROBASE`: must refer to the installation root directory @@ -76,7 +76,7 @@ Notes: the Xilinx environment. It uses `XTWI_PATH` to set up the ISE environment on the fly. For details consult 'man xtwi'. - don't run the ISE setup scripts ..../settings(32|64).sh in your working - shell. Setup only `XTWI_PATH` ! + shell. Set up only `XTWI_PATH` ! #### Compile UNISIM/UNIMACRO/SIMPRIM libraries for GHDL @@ -208,7 +208,7 @@ after a re-build. The make flow supports also loading the bitstream into FPGAs, either via Xilinx Impact, or via the Cypress FX2 USB controller is available. -For Xilinx Impact a Xilinx USB Cable II has to be properly setup, than +For Xilinx Impact a Xilinx USB Cable II has to be set up properly, than simply use make .iconfig diff --git a/doc/README_buildsystem_Vivado.md b/doc/README_buildsystem_Vivado.md index bff0d65b..607c46c2 100644 --- a/doc/README_buildsystem_Vivado.md +++ b/doc/README_buildsystem_Vivado.md @@ -3,8 +3,8 @@ ### Table of content - [Concept](#user-content-concept) -- [Setup system environment](#user-content-sysenv) - - [Setup environment variables](#user-content-envvar) +- [Set up system environment](#user-content-sysenv) + - [Set up environment variables](#user-content-envvar) - [Compile UNISIM/UNIMACRO libraries for GHDL](#user-content-ghdllibs) - [Building test benches](#user-content-buildtb) - [With GHDL](#user-content-buildtb-ghdl) @@ -60,9 +60,9 @@ maintained. For more details on `vbomconv` consult the man page. -### Setup system environment +### Set up system environment -#### Setup environment variables +#### Set up environment variables The build flows require the environment variables: - `RETROBASE`: must refer to the installation root directory @@ -75,7 +75,7 @@ Notes: the Xilinx environment. It uses `XTWV_PATH` to set up the Vivado environment on the fly. For details consult 'man xtwv'. - don't run the Vivado setup scripts ..../settings(32|64).sh in your working - shell. Setup only XTWV_PATH ! + shell. Set up only XTWV_PATH ! #### Compile UNISIM/UNIMACRO libraries for GHDL diff --git a/doc/README_known_issues.md b/doc/README_known_issues.md index 817125f5..21a6f0c5 100644 --- a/doc/README_known_issues.md +++ b/doc/README_known_issues.md @@ -156,7 +156,7 @@ of memory in 18 bit addressing. Seen originally for RK11, but RL11 and DEUNA are also affected. In normal operation is minor non-conformity is not relevant because operating -systems never setup DMA transfers to/from non-existing memory. However, some +systems never set up DMA transfers to/from non-existing memory. However, some highly space optimized crash dump routines use this to detect end-of-memory and might endless loop. Also maindec's might test this border case and fail. diff --git a/doc/w11a_os_guide.md b/doc/w11a_os_guide.md index 048b8b12..a5ff3c66 100644 --- a/doc/w11a_os_guide.md +++ b/doc/w11a_os_guide.md @@ -105,13 +105,13 @@ Recommended setups All examples below use the same basic setup -- setup `vt100` emulator windows +- set up `vt100` emulator windows cd $RETROBASE/tools/oskit/ console_starter -d DL0 & console_starter -d DL1 & -- setup rlink connection using `ti_rri` backend server via the `ti_w11` +- set up rlink connection using `ti_rri` backend server via the `ti_w11` quick start wrapper script. Ensure that all 8 switches on the board are in the indicated positions (SWI=...). The concrete boot script name is given in the following sections @@ -217,7 +217,7 @@ configuration, so will show in the emulator what w11a can do when finished. All examples below use the same basic setup -- setup vt100 emulator window for 1st and 2nd DL11 +- set up vt100 emulator window for 1st and 2nd DL11 cd $RETROBASE/tools/oskit/ console_starter -s -d DL0 & diff --git a/tools/fx2/sys/README.md b/tools/fx2/sys/README.md index 89c1b405..ef1ae7f0 100644 --- a/tools/fx2/sys/README.md +++ b/tools/fx2/sys/README.md @@ -10,7 +10,7 @@ is read/write accessible for user land processes, either in > Check with the `groups` command whether your account is in group `plugdev`, > in not, add this group to your accounts groups list.** -To setup udev rules do +To set up udev rules do ```bash sudo cp -a 90-retro-usb-permissions.rules /etc/udev/rules.d/ sudo chown root:root /etc/udev/rules.d/90-retro-usb-permissions.rules diff --git a/tools/oskit/211bsd_rp/CHANGELOG.md b/tools/oskit/211bsd_rp/CHANGELOG.md index 6e122784..e6c33f0a 100644 --- a/tools/oskit/211bsd_rp/CHANGELOG.md +++ b/tools/oskit/211bsd_rp/CHANGELOG.md @@ -42,7 +42,7 @@ ## 2017-05-25: Major update The oskit was so far an almost 'out-of-the-box' 211bsb tape distribution kit, -updated to version #447 and setup with a kernel including `FPSIM`. +updated to version #447 and set up with a kernel including `FPSIM`. The current revision for a first time brings a system tuned for w11a. ### Issues with old oskit (all fixed now) @@ -88,10 +88,10 @@ Setup 211bsd system from tape distribution kit obtained from [TUHS](https://www.tuhs.org/). - get tape distribution kit from [UnixArchive/Distributions/UCB/2.11BSD](https://www.tuhs.org/Archive/Distributions/UCB/2.11BSD/) - get patches from [UnixArchive/Distributions/UCB/2.11BSD/Patches](https://www.tuhs.org/Archive/Distributions/UCB/2.11BSD/Patches/) -- setup initial system using `SimH` +- set up initial system using `SimH` - load tape distribution kit (is version 431) - install all patches: 432,...,444 - `FPSIM` didn't work. Fixed with [patch #445](https://wfjm.github.io/blogs/211bsd/2007-01-03-patch-445.html). - boot from a `RK05` wasn't possible. Fixed with [patch #446+447](https://wfjm.github.io/blogs/211bsd/2009-01-04-patch-446+447.html). - build a kernel with `FPSIM` enabled (see `/sys/conf/RETRONFPNW`) -- setup oskits for RP06, RL02 and RK05 +- set up oskits for RP06, RL02 and RK05 diff --git a/tools/oskit/211bsd_rpeth/README.md b/tools/oskit/211bsd_rpeth/README.md index 1a301ca5..2879a60d 100644 --- a/tools/oskit/211bsd_rpeth/README.md +++ b/tools/oskit/211bsd_rpeth/README.md @@ -31,7 +31,8 @@ Download, unpack and copy the disk images (*.dsk), e.g. ### Usage -- Setup Ethernet environment, see [211bsd_ethernet.md](../doc/211bsd_ethernet.md) +- Set up Ethernet environment, + see [211bsd_ethernet.md](../doc/211bsd_ethernet.md) - Start backend server and boot system (see section Rlink in [w11a_os_guide](../../../doc/w11a_os_guide.md#user-content-rlink)) ``` diff --git a/tools/oskit/211bsd_tm/README.md b/tools/oskit/211bsd_tm/README.md index e6d436ef..4d8a7924 100644 --- a/tools/oskit/211bsd_tm/README.md +++ b/tools/oskit/211bsd_tm/README.md @@ -198,7 +198,7 @@ End of tape #### Install 211bsd, disk phase -The last command boots 211bsd form the just setup disk, which has now +The last command boots 211bsd from the just created disk, which has now a root file system, but not yet a hardward boot block. In the following - `#` is now the shell prompt - `!!` indicates comments diff --git a/tools/oskit/doc/211bsd_ethernet.md b/tools/oskit/doc/211bsd_ethernet.md index 4f9d24ae..65a04594 100644 --- a/tools/oskit/doc/211bsd_ethernet.md +++ b/tools/oskit/doc/211bsd_ethernet.md @@ -11,7 +11,7 @@ The _tap_ device should be created such that it is accessible by the account under with _ti_w11_ executes. This way only setting up _tap_ and _bridge_ require root access, but not subsequent usage. -Two support scripts help in the setup +Two support scripts help in the set up ``` ip_create_br ``` diff --git a/tools/sys/README.md b/tools/sys/README.md index 511e3f0c..d21f8a35 100644 --- a/tools/sys/README.md +++ b/tools/sys/README.md @@ -19,7 +19,7 @@ Use ``` to determine the `ID_SERIAL_SHORT` and create rules for your boards. -To setup udev rules do +To set up udev rules do ```bash cd $RETROBASE/tools/sys # !! adopt 92-retro-usb-persistent.rules to your needs !!