--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head>
+<!-- 2023-09-18 Mon 01:46 -->
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<title>Fifth - virtual machine</title>
+<meta name="author" content="Svjatoslav Agejenko" />
+<meta name="generator" content="Org Mode" />
+<style>
+ #content { max-width: 60em; margin: auto; }
+ .title { text-align: center;
+ margin-bottom: .2em; }
+ .subtitle { text-align: center;
+ font-size: medium;
+ font-weight: bold;
+ margin-top:0; }
+ .todo { font-family: monospace; color: red; }
+ .done { font-family: monospace; color: green; }
+ .priority { font-family: monospace; color: orange; }
+ .tag { background-color: #eee; font-family: monospace;
+ padding: 2px; font-size: 80%; font-weight: normal; }
+ .timestamp { color: #bebebe; }
+ .timestamp-kwd { color: #5f9ea0; }
+ .org-right { margin-left: auto; margin-right: 0px; text-align: right; }
+ .org-left { margin-left: 0px; margin-right: auto; text-align: left; }
+ .org-center { margin-left: auto; margin-right: auto; text-align: center; }
+ .underline { text-decoration: underline; }
+ #postamble p, #preamble p { font-size: 90%; margin: .2em; }
+ p.verse { margin-left: 3%; }
+ pre {
+ border: 1px solid #e6e6e6;
+ border-radius: 3px;
+ background-color: #f2f2f2;
+ padding: 8pt;
+ font-family: monospace;
+ overflow: auto;
+ margin: 1.2em;
+ }
+ pre.src {
+ position: relative;
+ overflow: auto;
+ }
+ pre.src:before {
+ display: none;
+ position: absolute;
+ top: -8px;
+ right: 12px;
+ padding: 3px;
+ color: #555;
+ background-color: #f2f2f299;
+ }
+ pre.src:hover:before { display: inline; margin-top: 14px;}
+ /* Languages per Org manual */
+ pre.src-asymptote:before { content: 'Asymptote'; }
+ pre.src-awk:before { content: 'Awk'; }
+ pre.src-authinfo::before { content: 'Authinfo'; }
+ pre.src-C:before { content: 'C'; }
+ /* pre.src-C++ doesn't work in CSS */
+ pre.src-clojure:before { content: 'Clojure'; }
+ pre.src-css:before { content: 'CSS'; }
+ pre.src-D:before { content: 'D'; }
+ pre.src-ditaa:before { content: 'ditaa'; }
+ pre.src-dot:before { content: 'Graphviz'; }
+ pre.src-calc:before { content: 'Emacs Calc'; }
+ pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
+ pre.src-fortran:before { content: 'Fortran'; }
+ pre.src-gnuplot:before { content: 'gnuplot'; }
+ pre.src-haskell:before { content: 'Haskell'; }
+ pre.src-hledger:before { content: 'hledger'; }
+ pre.src-java:before { content: 'Java'; }
+ pre.src-js:before { content: 'Javascript'; }
+ pre.src-latex:before { content: 'LaTeX'; }
+ pre.src-ledger:before { content: 'Ledger'; }
+ pre.src-lisp:before { content: 'Lisp'; }
+ pre.src-lilypond:before { content: 'Lilypond'; }
+ pre.src-lua:before { content: 'Lua'; }
+ pre.src-matlab:before { content: 'MATLAB'; }
+ pre.src-mscgen:before { content: 'Mscgen'; }
+ pre.src-ocaml:before { content: 'Objective Caml'; }
+ pre.src-octave:before { content: 'Octave'; }
+ pre.src-org:before { content: 'Org mode'; }
+ pre.src-oz:before { content: 'OZ'; }
+ pre.src-plantuml:before { content: 'Plantuml'; }
+ pre.src-processing:before { content: 'Processing.js'; }
+ pre.src-python:before { content: 'Python'; }
+ pre.src-R:before { content: 'R'; }
+ pre.src-ruby:before { content: 'Ruby'; }
+ pre.src-sass:before { content: 'Sass'; }
+ pre.src-scheme:before { content: 'Scheme'; }
+ pre.src-screen:before { content: 'Gnu Screen'; }
+ pre.src-sed:before { content: 'Sed'; }
+ pre.src-sh:before { content: 'shell'; }
+ pre.src-sql:before { content: 'SQL'; }
+ pre.src-sqlite:before { content: 'SQLite'; }
+ /* additional languages in org.el's org-babel-load-languages alist */
+ pre.src-forth:before { content: 'Forth'; }
+ pre.src-io:before { content: 'IO'; }
+ pre.src-J:before { content: 'J'; }
+ pre.src-makefile:before { content: 'Makefile'; }
+ pre.src-maxima:before { content: 'Maxima'; }
+ pre.src-perl:before { content: 'Perl'; }
+ pre.src-picolisp:before { content: 'Pico Lisp'; }
+ pre.src-scala:before { content: 'Scala'; }
+ pre.src-shell:before { content: 'Shell Script'; }
+ pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
+ /* additional language identifiers per "defun org-babel-execute"
+ in ob-*.el */
+ pre.src-cpp:before { content: 'C++'; }
+ pre.src-abc:before { content: 'ABC'; }
+ pre.src-coq:before { content: 'Coq'; }
+ pre.src-groovy:before { content: 'Groovy'; }
+ /* additional language identifiers from org-babel-shell-names in
+ ob-shell.el: ob-shell is the only babel language using a lambda to put
+ the execution function name together. */
+ pre.src-bash:before { content: 'bash'; }
+ pre.src-csh:before { content: 'csh'; }
+ pre.src-ash:before { content: 'ash'; }
+ pre.src-dash:before { content: 'dash'; }
+ pre.src-ksh:before { content: 'ksh'; }
+ pre.src-mksh:before { content: 'mksh'; }
+ pre.src-posh:before { content: 'posh'; }
+ /* Additional Emacs modes also supported by the LaTeX listings package */
+ pre.src-ada:before { content: 'Ada'; }
+ pre.src-asm:before { content: 'Assembler'; }
+ pre.src-caml:before { content: 'Caml'; }
+ pre.src-delphi:before { content: 'Delphi'; }
+ pre.src-html:before { content: 'HTML'; }
+ pre.src-idl:before { content: 'IDL'; }
+ pre.src-mercury:before { content: 'Mercury'; }
+ pre.src-metapost:before { content: 'MetaPost'; }
+ pre.src-modula-2:before { content: 'Modula-2'; }
+ pre.src-pascal:before { content: 'Pascal'; }
+ pre.src-ps:before { content: 'PostScript'; }
+ pre.src-prolog:before { content: 'Prolog'; }
+ pre.src-simula:before { content: 'Simula'; }
+ pre.src-tcl:before { content: 'tcl'; }
+ pre.src-tex:before { content: 'TeX'; }
+ pre.src-plain-tex:before { content: 'Plain TeX'; }
+ pre.src-verilog:before { content: 'Verilog'; }
+ pre.src-vhdl:before { content: 'VHDL'; }
+ pre.src-xml:before { content: 'XML'; }
+ pre.src-nxml:before { content: 'XML'; }
+ /* add a generic configuration mode; LaTeX export needs an additional
+ (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
+ pre.src-conf:before { content: 'Configuration File'; }
+
+ table { border-collapse:collapse; }
+ caption.t-above { caption-side: top; }
+ caption.t-bottom { caption-side: bottom; }
+ td, th { vertical-align:top; }
+ th.org-right { text-align: center; }
+ th.org-left { text-align: center; }
+ th.org-center { text-align: center; }
+ td.org-right { text-align: right; }
+ td.org-left { text-align: left; }
+ td.org-center { text-align: center; }
+ dt { font-weight: bold; }
+ .footpara { display: inline; }
+ .footdef { margin-bottom: 1em; }
+ .figure { padding: 1em; }
+ .figure p { text-align: center; }
+ .equation-container {
+ display: table;
+ text-align: center;
+ width: 100%;
+ }
+ .equation {
+ vertical-align: middle;
+ }
+ .equation-label {
+ display: table-cell;
+ text-align: right;
+ vertical-align: middle;
+ }
+ .inlinetask {
+ padding: 10px;
+ border: 2px solid gray;
+ margin: 10px;
+ background: #ffffcc;
+ }
+ #org-div-home-and-up
+ { text-align: right; font-size: 70%; white-space: nowrap; }
+ textarea { overflow-x: auto; }
+ .linenr { font-size: smaller }
+ .code-highlighted { background-color: #ffff00; }
+ .org-info-js_info-navigation { border-style: none; }
+ #org-info-js_console-label
+ { font-size: 10px; font-weight: bold; white-space: nowrap; }
+ .org-info-js_search-highlight
+ { background-color: #ffff00; color: #000000; font-weight: bold; }
+ .org-svg { }
+</style>
+<link rel="stylesheet" type="text/css" href="https://thomasf.github.io/solarized-css/solarized-dark.min.css" />
+</head>
+<body>
+<div id="content" class="content">
+<h1 class="title">Fifth - virtual machine</h1>
+<div id="table-of-contents" role="doc-toc">
+<h2>Table of Contents</h2>
+<div id="text-table-of-contents" role="doc-toc">
+<ul>
+<li><a href="#org5215c98">1. Instructions overview</a>
+<ul>
+<li><a href="#orgad315b0">1.1. kbd@ - read scancode of pressed or released key</a></li>
+<li><a href="#org944323a">1.2. vidput - put image1 into image2, at location x, y</a></li>
+<li><a href="#org5b4d781">1.3. cmove - copy memory array</a></li>
+<li><a href="#orgb1e3963">1.4. tvidput - put image with transparency support</a></li>
+<li><a href="#orgac6e38a">1.5. charput - draw text character</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<p>
+Current emulator emulates:
+</p>
+<ul class="org-ul">
+<li>1 CPU.</li>
+<li>It has 2 stacks</li>
+<li>~50 instructions</li>
+<li>4GB flat address space (theoretically).</li>
+</ul>
+
+
+<p>
+While I tried to keep instruction set simple, I was forced to put in
+some complex instructions to make performance acceptable on
+emulator.
+</p>
+
+<p>
+CPU has following registers:
+</p>
+<dl class="org-dl">
+<dt>IP</dt><dd>instruction pointer</dd>
+<dt>DSP</dt><dd>data stack pointer</dd>
+<dt>RSP</dt><dd>return stack pointer</dd>
+</dl>
+
+<div id="outline-container-org5215c98" class="outline-2">
+<h2 id="org5215c98"><span class="section-number-2">1.</span> Instructions overview</h2>
+<div class="outline-text-2" id="text-1">
+<p>
+Virtual CPU, commands (most of them are avaiable as ordinary commands
+in programming language):
+</p>
+
+
+<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
+
+
+<colgroup>
+<col class="org-right" />
+
+<col class="org-left" />
+
+<col class="org-left" />
+
+<col class="org-left" />
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="org-right">#</th>
+<th scope="col" class="org-left">name</th>
+<th scope="col" class="org-left">stack footprint</th>
+<th scope="col" class="org-left">description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="org-right">0</td>
+<td class="org-left">nop</td>
+<td class="org-left">--</td>
+<td class="org-left">does nothing</td>
+</tr>
+
+<tr>
+<td class="org-right">1</td>
+<td class="org-left">halt</td>
+<td class="org-left">--</td>
+<td class="org-left">halt CPU ( return to DOS on emulator )</td>
+</tr>
+
+<tr>
+<td class="org-right">2</td>
+<td class="org-left"><a href="#orgad315b0">kbd@</a></td>
+<td class="org-left">– c</td>
+<td class="org-left">read scancode of pressed or released key</td>
+</tr>
+
+<tr>
+<td class="org-right">3</td>
+<td class="org-left">num <dword></td>
+<td class="org-left">– n</td>
+<td class="org-left">put immidiate number into datastack</td>
+</tr>
+
+<tr>
+<td class="org-right">4</td>
+<td class="org-left">jmp <dword></td>
+<td class="org-left">--</td>
+<td class="org-left">jump to specified code</td>
+</tr>
+
+<tr>
+<td class="org-right">5</td>
+<td class="org-left">call <dword></td>
+<td class="org-left"> </td>
+<td class="org-left">jump to specified code, save return address to return stack</td>
+</tr>
+
+<tr>
+<td class="org-right">6</td>
+<td class="org-left">1+</td>
+<td class="org-left">n – n+1</td>
+<td class="org-left"> </td>
+</tr>
+
+<tr>
+<td class="org-right">7</td>
+<td class="org-left">1-</td>
+<td class="org-left">n – n-1</td>
+<td class="org-left"> </td>
+</tr>
+
+<tr>
+<td class="org-right">8</td>
+<td class="org-left">dup</td>
+<td class="org-left">n – n n</td>
+<td class="org-left">duplicate top of data stack</td>
+</tr>
+
+<tr>
+<td class="org-right">9</td>
+<td class="org-left">drop</td>
+<td class="org-left">n --</td>
+<td class="org-left">drop last element in data stack</td>
+</tr>
+
+<tr>
+<td class="org-right">10</td>
+<td class="org-left">if <dword></td>
+<td class="org-left">n --</td>
+<td class="org-left">jump to addr if top element was 0</td>
+</tr>
+
+<tr>
+<td class="org-right">11</td>
+<td class="org-left">ret</td>
+<td class="org-left"> </td>
+<td class="org-left">jump to code, specified in return stack.</td>
+</tr>
+
+<tr>
+<td class="org-right">12</td>
+<td class="org-left">c@</td>
+<td class="org-left">addr – n</td>
+<td class="org-left">read byte from memory at specified address</td>
+</tr>
+
+<tr>
+<td class="org-right">13</td>
+<td class="org-left">c!</td>
+<td class="org-left">n addr --</td>
+<td class="org-left">store byte to specified memory</td>
+</tr>
+
+<tr>
+<td class="org-right">14</td>
+<td class="org-left">push</td>
+<td class="org-left">DSTK -> RSTK</td>
+<td class="org-left">move top of datastack to returnstack</td>
+</tr>
+
+<tr>
+<td class="org-right">15</td>
+<td class="org-left">pop</td>
+<td class="org-left">RSTK -> DSTK</td>
+<td class="org-left">move top of returnstack to datastack</td>
+</tr>
+
+<tr>
+<td class="org-right">16</td>
+<td class="org-left"><unused></td>
+<td class="org-left"> </td>
+<td class="org-left"> </td>
+</tr>
+
+<tr>
+<td class="org-right">17</td>
+<td class="org-left">rot</td>
+<td class="org-left">n1 n2 n3 – n2 n3 n1</td>
+<td class="org-left">rotate stack elements</td>
+</tr>
+
+<tr>
+<td class="org-right">18</td>
+<td class="org-left">disk@</td>
+<td class="org-left">FromDiskSect ToMem --</td>
+<td class="org-left">read 1KB from disk into RAM</td>
+</tr>
+
+<tr>
+<td class="org-right">19</td>
+<td class="org-left">disk!</td>
+<td class="org-left">FromMem ToDiskSect --</td>
+<td class="org-left">write 1KB to disk</td>
+</tr>
+
+<tr>
+<td class="org-right">20</td>
+<td class="org-left">@</td>
+<td class="org-left">addr – n</td>
+<td class="org-left">read 32 bit number from memory</td>
+</tr>
+
+<tr>
+<td class="org-right">21</td>
+<td class="org-left">!</td>
+<td class="org-left">n addr --</td>
+<td class="org-left">store 32 bit number to memory</td>
+</tr>
+
+<tr>
+<td class="org-right">22</td>
+<td class="org-left">over</td>
+<td class="org-left">n1 n2 – n1 n2 n1</td>
+<td class="org-left"> </td>
+</tr>
+
+<tr>
+<td class="org-right">23</td>
+<td class="org-left">swap</td>
+<td class="org-left">n1 n2 – n2 n1</td>
+<td class="org-left"> </td>
+</tr>
+
+<tr>
+<td class="org-right">24</td>
+<td class="org-left">+</td>
+<td class="org-left">n1 n2 – n1+n2</td>
+<td class="org-left"> </td>
+</tr>
+
+<tr>
+<td class="org-right">25</td>
+<td class="org-left">-</td>
+<td class="org-left">n1 n2 – n1-n2</td>
+<td class="org-left"> </td>
+</tr>
+
+<tr>
+<td class="org-right">26</td>
+<td class="org-left">*</td>
+<td class="org-left">n1 n2 – n1*n2</td>
+<td class="org-left"> </td>
+</tr>
+
+<tr>
+<td class="org-right">27</td>
+<td class="org-left">/</td>
+<td class="org-left">n1 n2 – n1/n2</td>
+<td class="org-left"> </td>
+</tr>
+
+<tr>
+<td class="org-right">28</td>
+<td class="org-left">></td>
+<td class="org-left">n1 n2 – result</td>
+<td class="org-left">is true when n1 > n2</td>
+</tr>
+
+<tr>
+<td class="org-right">29</td>
+<td class="org-left"><</td>
+<td class="org-left">n1 n2 – result</td>
+<td class="org-left">is true when n1 < n2</td>
+</tr>
+
+<tr>
+<td class="org-right">30</td>
+<td class="org-left">not</td>
+<td class="org-left">n1 – not_n1</td>
+<td class="org-left">logical not</td>
+</tr>
+
+<tr>
+<td class="org-right">31</td>
+<td class="org-left">i</td>
+<td class="org-left">– n</td>
+<td class="org-left">copies top of return stack into datastack</td>
+</tr>
+
+<tr>
+<td class="org-right">32</td>
+<td class="org-left">cprt@</td>
+<td class="org-left">addr – n</td>
+<td class="org-left">read one byte from hardware port</td>
+</tr>
+
+<tr>
+<td class="org-right">33</td>
+<td class="org-left">cprt!</td>
+<td class="org-left">n addr --</td>
+<td class="org-left">store one byte to hardware port</td>
+</tr>
+
+<tr>
+<td class="org-right">34</td>
+<td class="org-left">i2</td>
+<td class="org-left">– n</td>
+<td class="org-left">like "i" but takes second top stack element</td>
+</tr>
+
+<tr>
+<td class="org-right">35</td>
+<td class="org-left">i3</td>
+<td class="org-left">– n</td>
+<td class="org-left">like "i" but takes third top stack element.</td>
+</tr>
+
+<tr>
+<td class="org-right">36</td>
+<td class="org-left">shl</td>
+<td class="org-left">n amount – n</td>
+<td class="org-left">left bit shift</td>
+</tr>
+
+<tr>
+<td class="org-right">37</td>
+<td class="org-left">shr</td>
+<td class="org-left">n amount – n</td>
+<td class="org-left">right bit shift</td>
+</tr>
+
+<tr>
+<td class="org-right">38</td>
+<td class="org-left">or</td>
+<td class="org-left">n1 n2 – n</td>
+<td class="org-left">logical or</td>
+</tr>
+
+<tr>
+<td class="org-right">39</td>
+<td class="org-left">xor</td>
+<td class="org-left">n1 n2 – n</td>
+<td class="org-left">exclusive logical or</td>
+</tr>
+
+<tr>
+<td class="org-right">40</td>
+<td class="org-left">vidmap</td>
+<td class="org-left">addr --</td>
+<td class="org-left">copy memory from "addr" to video memory.</td>
+</tr>
+
+<tr>
+<td class="org-right">41</td>
+<td class="org-left">mouse@</td>
+<td class="org-left">– x y button</td>
+<td class="org-left">read mouse coordinates & buttons</td>
+</tr>
+
+<tr>
+<td class="org-right">42</td>
+<td class="org-left"><a href="#org944323a">vidput</a></td>
+<td class="org-left">addr1 addr2 x y --</td>
+<td class="org-left">put image1 into image2, at location x, y</td>
+</tr>
+
+<tr>
+<td class="org-right">43</td>
+<td class="org-left"><a href="#org5b4d781">cmove</a></td>
+<td class="org-left">addr1 addr2 amount</td>
+<td class="org-left">move memory from addr1 to addr2</td>
+</tr>
+
+<tr>
+<td class="org-right">44</td>
+<td class="org-left">cfill</td>
+<td class="org-left">c addr amount --</td>
+<td class="org-left">fill memory starting at "addr" with "c" bytes.</td>
+</tr>
+
+<tr>
+<td class="org-right">45</td>
+<td class="org-left"><a href="#orgb1e3963">tvidput</a></td>
+<td class="org-left">addr1 addr2 x y --</td>
+<td class="org-left">put image with transparency support</td>
+</tr>
+
+<tr>
+<td class="org-right">46</td>
+<td class="org-left">depth</td>
+<td class="org-left">– depth</td>
+<td class="org-left">returns current depth of data stack.</td>
+</tr>
+
+<tr>
+<td class="org-right">47</td>
+<td class="org-left"><a href="#orgac6e38a">charput</a></td>
+<td class="org-left">colorfg colorbg addrsrc addrdest x y</td>
+<td class="org-left">draw text character</td>
+</tr>
+</tbody>
+</table>
+</div>
+
+<div id="outline-container-orgad315b0" class="outline-3">
+<h3 id="orgad315b0"><span class="section-number-3">1.1.</span> kbd@ - read scancode of pressed or released key</h3>
+<div class="outline-text-3" id="text-1-1">
+<p>
+Returns 0 if no data available.
+</p>
+</div>
+</div>
+<div id="outline-container-org944323a" class="outline-3">
+<h3 id="org944323a"><span class="section-number-3">1.2.</span> vidput - put image1 into image2, at location x, y</h3>
+<div class="outline-text-3" id="text-1-2">
+<p>
+Does clipping, so part of a big image can be mapped into smaller one.
+</p>
+</div>
+</div>
+<div id="outline-container-org5b4d781" class="outline-3">
+<h3 id="org5b4d781"><span class="section-number-3">1.3.</span> cmove - copy memory array</h3>
+<div class="outline-text-3" id="text-1-3">
+<p>
+Move memory from addr1 to addr2. If addr1 is greater than addr2 then
+count address foward while moving, elseway starts from end and counts
+backwards, so no data loss occurs when memory regions partially
+overlap.
+</p>
+</div>
+</div>
+<div id="outline-container-orgb1e3963" class="outline-3">
+<h3 id="orgb1e3963"><span class="section-number-3">1.4.</span> tvidput - put image with transparency support</h3>
+<div class="outline-text-3" id="text-1-4">
+<p>
+Stack footprint
+</p>
+<pre class="example">
+addr1 addr2 x y --
+</pre>
+
+
+<p>
+Put image1 into image2, at location x, y with transparency support
+</p>
+
+<p>
+Color 255 in source image is treated as transparent.
+</p>
+</div>
+</div>
+<div id="outline-container-orgac6e38a" class="outline-3">
+<h3 id="orgac6e38a"><span class="section-number-3">1.5.</span> charput - draw text character</h3>
+<div class="outline-text-3" id="text-1-5">
+<p>
+Draw character to image buffer located at "addrdest" to specified x &
+y location. Decodes 8 bytes from source to bits, used to draw
+character.
+</p>
+</div>
+</div>
+</div>
+</div>
+<div id="postamble" class="status">
+<p class="author">Author: Svjatoslav Agejenko</p>
+<p class="date">Created: 2023-09-18 Mon 01:46</p>
+<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
+</div>
+</body>
+</html>
projects / fifth.git / blobdiff