Skip to content

Latest commit

 

History

History
169 lines (124 loc) · 5.73 KB

INSTALL_quickstart.md

File metadata and controls

169 lines (124 loc) · 5.73 KB

Quick start Guide

This quick start guide describes the fastest possible path to a running operating system on a w11 on current Series-7 based boards. It leaves out legacy Spartan-3 and Spartan-6 designs, verification, test benches, test designs, and many other aspects. For all this consult the full INSTALL, the guide to boot operating systems, and the READMEs in doc. This write-up focuses on the steps prepare, build and boot, and gives one concrete example. For a quick look at the source code see doxygen source viewer.

Prepare

First all required software must be installed

  • clone the w11 project, essentially

    git clone https://github.com/wfjm/w11

    for details see INSTALL#download.

  • ensure the packages required for the backend software are installed, see INSTALL#sysreq, and that Xilinx Vivado is installed.

  • set up the shell environment, see INSTALL#envvar,

    export RETROBASE=<install-dir>
export PATH=$PATH:$RETROBASE/tools/bin:.
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$RETROBASE/tools/lib

export TCLINC=/usr/include/tcl8.6
export TCLLIBNAME=tcl8.6

export XTWV_PATH=<install-path-of-vivado>

    set up the TCL environment, see INSTALL#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 set up, see tools/sys/README.

  • compile the backend software tools

     cd $RETROBASE/tools/src
 time make -j 4

 cd $RETROBASE/tools/tcl
 setup_packages

    see INSTALL#build-tools.

Build: generate bit file and configure FPGA

All details of the Vivado implementation flow are encapsulated by the build system in a simple make command

cd $RETROBASE/rtl/sys_gen/w11a/<board>
time make sys_w11a_<btype>.bit

with the currently supported combinations

board           btype     memory   Comment
arty            arty     3840 kB   Digilent Arty A7-35 board
basys3          b3        176 kB   Digilent Basys3 board
cmoda7          c7        672 kB   Digilent Cmod A7 board
nexys4          n4       3840 kB   Digilent Nexys4 board (cellular RAM)
nexys4d         n4d      3840 kB   Digilent Nexys A7-100 board (DDR2)

The FPGA is configured via the Vivado hardware server with

make sys_w11a_<btype>.vconfig

Boot an operating system

A variety of oskits is provided under tools/oskit. The quick start guide describes only how to boot plain 2.11BSD. The full-featured 211bsd_rp can be used when more than 1024 kB memory is available, for systems with 512 to 1024 kB memory use the pruned down 211bsd_rpmin. For 2.11BSD with Ethernet, other OS, and more details consult w11a_os_guide.

Key steps are

  • consult the README in the oskit directory and download the disk image files, typically with a wget and tar command

  • set up vt100 emulator windows

    cd $RETROBASE/tools/oskit/<oskit-name>
console_starter -d DL0 &
console_starter -d DL1 &

  • configure the board switches (important!!) and start the backend software with the options as described in w11a_os_guide#rlink, typically

    cd $RETROBASE/tools/oskit/<oskit-name>
ti_w11 <options> @<oskit-name>_boot.tcl

    Hit <ENTER> in the DL0vt100 console window to connect, than follow the expected startup sequence on the console DL0vt100 is described in the README in the oskit directory.

Concrete test run

The recipe was tested

  • system environment

    • Kubuntu 20.04 LTS (focal) with gcc 9.4.0
    • Vivado 2020.1
    • on 2022-04-29

  • after commit 7ec5be2a

    cd $RETROBASE/tools/src
time make -j 4
  # real 3m5.530s   user 5m9.533s   sys 0m22.052s

  • for design nexys4d for Nexys4 DDR or Nexys A7-100 boards.

    cd $RETROBASE/rtl/sys_gen/w11a/nexys4d
time make sys_w11a_n4d.bit
# real 21m40.918s   user 10m39.529s   sys 1m17.014s
time make sys_w11a_n4d.vconfig
# real 0m35.288s   user 0m21.578s   sys 0m2.369s

  • for oskit 211bsd_rp

    • in Linux terminal

      cd $RETROBASE/tools/oskit/211bsd_rp
211bsd_rp_setup

console_starter -d DL0 &
console_starter -d DL1 &

# set board switches to SWI = 00000000 00101000
ti_w11 -tuD,12M,break,cts  @211bsd_rp_boot.tcl

    • in window DL0 vt100 hit <ENTER> to connect to backend, than see output and do required inputs as written in the README:

      70Boot from xp(0,0,0) at 0176700
: {<CR>}
: xp(0,0,0)unix
Boot: bootdev=05000 bootcsr=0176700
...
# ^D
...
login: {root}

    • feel free to explore also the second console in window DL1 vt100, hit <ENTER> and start a 2nd session on the 2.11BSD system.

    • when done with exploring 2.11BSD do proper system shutdown

      • in 211bsd session type shutdown -h now
      • in ti_w11 session wait for CPU attention and H:cpu0 prompt, than exit with ^D.