PiDP-8/I Software

Artifact [1855b98236]
Log In

Artifact 1855b98236a5b99660eb288b373f510babe0ce39:

Wiki page [Home] by tangent 2019-08-09 00:42:53.
D 2019-08-09T00:42:53.239
L Home
N text/x-markdown
P 2aa45721285be23371f601d1c0f686c2ae00b8d5
U tangent
W 13805
# What It Is

This repository is the current [official](https://groups.google.com/d/msg/pidp-8/VXt914aAttg/E6ECG0KLCAAJ) PiDP-8/I software development nexus. Here we continue development of the software from the last stable software version published on the [kit information site](http://obsolescence.wixsite.com/obsolescence/pidp-8-details). This software differs in [several major ways](/wiki?name=Major+Differences) and [dozens of minor ways][cl] from that old software.


# <a name="src"></a>Getting Started: Source Code

The efficient method to get started is to install this software into an existing [Raspbian](https://www.raspberrypi.org/downloads/raspbian/) installation on the Pi which you are using with the PiDP-8/I board. It also works with [some other OSes](https://tangentsoft.com/pidp8i/wiki?name=OS+Compatibility).

You can download the latest release — cut on 2019.04.25 — as [a tarball](/tarball/pidp8i-v2019.04.25.tar.gz?r=release). (About **7.5 MB**.)

If you want the bleeding edge version, you can either check it out from the Fossil source code repository powering this web site by following the instructions in [the hackers' guide](/doc/trunk/HACKERS.md) or you can simply download the tip of trunk as [a tarball](/tarball/pidp8i-trunk.tar.gz).

See [the `README.md` file](/doc/trunk/README.md) for more information on how to install this into your existing Raspberry Pi OS.


# <a name="bosi"></a>Getting Started: Binary OS Images

Those with plenty of Internet bandwidth and a micro SD card they don't mind overwriting may prefer to download the software hosted here in binary OS image form. There are two versions, each based on Raspbian Stretch Lite and each roughly **500 MB**:

1. [Multi-core version](https://tangentsoft.com/dl/pidp8i-2019.04.25-ils-stretch-lite.img.zip), v2019.04.25 — This OS image is built with the [incandescent lamp simulator](wiki?name=Incandescent+Lamp+Simulator) which only works properly on the multi-core Raspberry Pi 2 and 3 boards. (All models.)

    It takes about one and a half of the four available CPU cores on a Pi 3B while running about *24&times;* faster than a real PDP-8/I. I do not know the numbers for a Pi 2.

2. [Single-core version](https://tangentsoft.com/dl/pidp8i-2019.04.25-nls-stretch-lite.img.zip), v2019.04.25 — For those running on Raspberry Pi Model A+ and B+ boards or the Pi Zero, this alternative download disables the ILS feature. It also slows the simulator down so it uses only about half the available CPU power to leave some host CPU power for background tasks. This allows it to run PDP-8 software roughly *3&times;* as fast as a real PDP-8/I, depending on the speed of the Pi you run it on.

    This image will also run on a multi-core Pi. It will run PDP-8 software slower than the ILS version, since it will also be affected by the intentional 50% CPU usage limit, but because each one of those cores are faster than a single-core Pi and the other cores can take the load of background tasks, it still manages to run PDP-8 software roughly *10&times;* faster than a real PDP-8/I.

See the [installation instructions](/doc/trunk/doc/OS-images.md) for more information.

The binary OS releases are not always updated when the source code releases are cut, since it is a fair amount of work to do those binary releases. Addressing that is the topic of the next section.


## <a name="updating"></a>Updating the Binary OS Release

As shipped, the binary OS images above also contain the PiDP-8/I software source code and Fossil, the tool that lets you download updated source code as it becomes available. Updating the software is therefore much simpler than downloading the whole OS all over again and overwriting your perfectly good SD card. If you are updating your existing release to a newer release version, this works:

    $ cd ~/pidp8i
    $ fossil update
    $ make reconfig
    $ tools/mmake && sudo make install
    $ sudo systemctl daemon-reload
    $ pidp8i restart
    $ pidp8i

If you need to switch from the [release branch](/timeline?r=release) to the bleeding-edge "trunk" version — such as because you want to try a change that has not yet been released — simply modify the second command like so:

    $ fossil update trunk

You only need the branch argument to the `fossil update` command when switching branches. Once you've switched from the release branch to the trunk, you don't need to keep specifying "trunk" because Fossil keeps your checkout directory on a given branch once you've switched to it. Thus, you'd only need to give a branch name when switching back to the release branch:

    $ fossil update release

The above commands assume typical situations and default options. For more advanced cases, see [the `README.md` file](/doc/trunk/README.md).


## <a id="os8"></a>OS/8 RK05 Media

One of the most time consuming steps in building our PiDP-8/I software is building the OS/8 RK05 disk images from pristine, tested, curated sources. If you simply want the resulting disk images, we provide them here for you to download:

| Base Name | Contents
| ---------- | ---------
| [`boot`](/uv/v3d.rk05) | bootable OS/8 V3D RK05 disk image with selected [add-ons](/doc/trunk/README.md#disable-os8) and [patches](/doc/trunk/doc/os8-patching.md)
| [`dist`](/uv/v3d-dist.rk05) | same as `boot` but with OS/8 in its as-distributed state: no patches, no add-ons
| [`src`](/uv/v3d-src.rk05) | non-bootable disk containing the contents of all ten OS/8 V3D source tapes

These disk images were last updated on 2019.04.25 in conjunction with [the release made at the same time](/doc/trunk/ChangeLog.md#20190425) and so are considered stable.

These disk images should work under SIMH on any platform, and could potentially even be written back to real RK05 disk packs and run on actual PDP-8 hardware! Let us know how you're using these files on the [PiDP-8/I mailing list](groups.google.com/forum/#!forum/pidp-8); we're curious how far these spread.

If you want a version of the `bin` disk image with any of the optional [`--enable-os8-*`](/doc/trunk/README.md#enable-os8) options set or with some of the default-enabled features stripped out, you will have to download this software, configure it as suits your needs, and build it yourself. The software currently builds on [several different platforms](/wiki?name=OS+Compatibility), not just the Raspberry Pi.


# <a name="learning"></a>Learning More

### <a name="upstream"></a>Official Project Resources

Much of the information on Oscar Vermeulen's [PiDP-8/I project site](http://obsolescence.wixsite.com/obsolescence/pidp-8) still applies to this distribution of the software for the PiDP-8/I.

Our version has [many more features and many fewer bugs][cl] than Oscar's version, but in the end, both do more or less the same thing, so that Oscar's documentation still applies fairly well to our version. The primary source of discrepancies between his documentation and our software stem from [file name changes](/wiki?name=Major+Differences). For example, in Oscar's article "[How to use the PiDP-8/I](http://obsolescence.wixsite.com/obsolescence/how-to-use-the-pidp-8)," the only difference I see in a quick skim is that you now have to type `pdp8i` at the Raspbian command line to attach your terminal to the PiDP-8/I simulator rather than `pdp.sh`.

You are also welcome to discuss this version of the PiDP-8/I software on [the PiDP-8/I mailing list](groups.google.com/forum/#!forum/pidp-8), hosted by Google Groups. Those active in its development participate there and usually react to posts about this software quickly.


### <a name="pdoc"></a>Project Documentation

This software project has its own documentation and tutorials, which I've collected here for convenience:

*   [The top-level README file](/doc/trunk/README.md) tells how to configure, build, and start using the PiDP-8/I software. It is not meant to replace the other resources available, only to give a fast-track guide to someone getting started. The primary bit of unique info it presents is documentation of the `configure` script flags.

*   One of those `configure` script flags is complicated enough to deserve its own document, [`--throttle`](/doc/trunk/README-throttle.md).

*   The [installation instructions](/doc/trunk/doc/OS-images.md) explain how to install the [binary OS images](#bosi) to an SD card and get started with it.

*   While building your PiDP-8/I, you may run into some trouble which can be diagnosed by the `pidp8i-test` program shipped with the software distribution and [documented here](/doc/trunk/doc/pidp8i-test.md).

*   [The project wiki](/wcontent) contains several tutorials, design documents, etc.

*   The project ships [several example programs](/file/examples) for those who want to learn to program the PDP-8. This is not meant to be a comprehensive tutorial, but more to help you bridge the gap in material meant for a real PDP-8, which won't talk about the superior methods we have for program input now: SIMH boot scripts, copy-paste via SSH, etc.

*    We ship a Python class called `simh` for controlling SIMH and OS/8 running under SIMH from the host system. See [its tutorial](/doc/trunk/doc/class-simh.md).

*   There is [a tutorial for the DCP disassembler](/doc/trunk/doc/dcp_wu.md) installed on the OS/8 disk packs by default.

*   The default OS/8 boot disk in the distribution has [many patches applied](/doc/trunk/doc/os8-patching.md), which are described in the linked document, along with information about the DEC patches we have chosen *not* to apply.

*   There are several documents about the U/W FOCAL V4E distribution included on the standard OS/8 boot disk, which you can find by starting with our [U/W FOCAL manual supplement](/doc/trunk/doc/uwfocal-manual-supp.md).

*   If you want to know what has changed in the software since Oscar Vermeulen's last release on 2015.12.15, see [the ChangeLog][cl].

*    If you would like to help contribute to the development of the PiDP-8/I software project, see "[Hacking on the PiDP-8/I Software](/doc/trunk/HACKERS.md)".

*   The KiCad [PiDP-8/I front panel schematic](/doc/trunk/hardware/pdp8i/schematic.pdf) was converted to PDF by Tony Hill. (400 kB)

*   Are you wondering who brought all of this software, hardware, and documentation to you? That is summarized in the project's [authors file](/doc/trunk/AUTHORS.md). Those pieces are included with the project under [a variety of licenses](/doc/trunk/COPYING.md).

[cl]: /doc/trunk/ChangeLog.md


### <a name="sdoc"></a>SIMH Documentation

The PiDP-8/I software project is based on [the actively-developed official version of SIMH](https://github.com/simh/simh). (As opposed to Bob Supnik's personal 3.<i>x</i> branch which still comes up high in search results.) The SIMH project has its own documentation, but for convenience I've provided PDF versions of the relevant subset here:

*   [SIMH Main Manual](/uv/doc/simh/main.pdf) — If you're going to read or modify `boot/*.script`, or you want to give commands at the `sim>` prompt you get by pressing Ctrl-E from within the PiDP-8/I simulator, you need to read this manual.

*   [PDP-8 Simulator Manual](/uv/doc/simh/pdp8.pdf) — This addendum to the main SIMH manual covers the details specific to the PDP-8 simulator. (The main manual covers functionality common to all of the simulators bundled with SIMH.)

*   [SIMH FAQ](/uv/doc/simh/faq.pdf) — Frequently-asked questions about SIMH. (With answers!)


### <a name="rdoc"></a>Rare PDP-8 Documentation

While most of the information about the PDP-8 is widely available on the Internet and may thus be easily found [by Googling](https://www.google.com/search?q=pdp-8), we have a small number of documents here that are not so easy to come by, plus some links that don't seem to come up as high in Google searches as they ought to:

*   DEC's 1969 edition [System User's Guide](/uv/doc/pdp8i-sug.pdf) for the PDP-8 family computers, the pinnacle of which was the PDP-8/I at that time. DEC published many editions of this guide, and the newer versions come up far more frequently in web searches, but they're often not OCR'd (whereas this version is) and they tend to focus on the newer PDP-8 models which don't apply entirely to the PDP-8/I.

*   DEC's 1973 [Small Computer Handbook](https://archive.org/details/bitsavers_decpdp8hanHandbook1973_79671711), because when dealing with SIMH, you actually *want* documentation of the newer models of PDP-8, since SIMH simulates a fairly tricked-out late-model PDP-8; there is no easy way to restrict SIMH to support only the features that existed at the time of the PDP-8/I. For example, SIMH's PDP-8 simulator will process [mode B EAE instructions](http://homepage.divms.uiowa.edu/~jones/pdp8/refcard/74.html) introduced in the PDP-8/e, well after the PDP-8/I came out with its less functional EAE option.

    You may want to split the difference between these two documents and try to find a 1968 edition of the Small Computer Handbook. The closest I'm aware of online is the [1967 edition](http://bitsavers.org/pdf/dec/pdp8/handbooks/SmallComputerHandbook_67-68.pdf) which mentions the PDP-8/I inside, but shows the original PDP-8 "Straight Eight" and a PDP-8/S on the cover. I assume it was written while the PDP-8/I design was being finalized, so it may be fairly accurate, and it may be full of bugs; I couldn't say. I happen to have here a paper copy of the 1968 edition, which you can tell from the 1967 edition by the [yellow-green themed cover](/doc/trunk/doc/dec-sch-pdp8i-1968.jpg) (JPEG, 473&nbsp;kB) showing the standard rack-mounted and rare console version of the PDP-8/I.
Z bda43327872cee41449e6fb2fd517feb