Annotation of nono/doc/index.php, revision 1.1.1.1

1.1       root        1: <html><?php
                      2:        $nono_ver = "";
                      3: 
                      4:        if ($_SERVER['argc'] > 1)
                      5:                get_version($_SERVER['argv'][1]);
                      6: 
                      7: function get_version($filename)
                      8: {
                      9:        global $nono_ver;
                     10: 
                     11:        $fp = fopen($filename, "r");
                     12:        if ($fp !== false) {
                     13:                while (($buf = fgets($fp)) !== false) {
                     14:                        if (preg_match("/NONO_MAJOR_VER\s+\((\d+)\)/", $buf, $m)) {
                     15:                                $nono_major = $m[1];
                     16:                        }
                     17:                        if (preg_match("/NONO_MINOR_VER\s+\((\d+)\)/", $buf, $m)) {
                     18:                                $nono_minor = $m[1];
                     19:                        }
                     20:                        if (preg_match("/NONO_PATCH_VER\s+\((\d+)\)/", $buf, $m)) {
                     21:                                $nono_patch = $m[1];
                     22:                        }
                     23:                        if (preg_match("/NONO_DATE\s+\"([^\"]+)\"/", $buf, $m)) {
                     24:                                $nono_date = $m[1];
                     25:                        }
                     26:                }
                     27:                fclose($fp);
                     28: 
                     29:                $nono_ver = "${nono_major}.${nono_minor}.${nono_patch} (${nono_date})";
                     30:        }
                     31: }
                     32: ?>
                     33: <head>
                     34: <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
                     35: <title>nono document</title>
                     36: <style type="text/css">
                     37: /* https://jfly.uni-koeln.de/colorset/ */
                     38: 
                     39: :root {
                     40:        --blue:                 rgb(  0,  90, 255);
                     41:        --brown:                rgb(128,  64,   0);
                     42:        --green:                rgb(  3, 175, 122);
                     43:        --grey:                 rgb(132, 145, 158);
                     44:        --light-grey:   rgb(200, 200, 203);
                     45: }
                     46: body {
                     47:        background-color: var(--light-grey);
                     48: }
                     49: q {
                     50:        color: var(--brown);
                     51: }
                     52: q:before {
                     53:        content: "[";
                     54: }
                     55: q:after {
                     56:        content: "]";
                     57: }
                     58: dt.dt-indent {
                     59:        padding-left: 1ex;
                     60: }
                     61: .main {
                     62:        margin-left: 1em;
                     63: }
                     64: .cons {
                     65:        background-color: black;
                     66:        color: white;
                     67: }
                     68: .file {
                     69:        background-color: white;
                     70:        color: black;
                     71: }
                     72: .strike {
                     73:        color: var(--grey);
                     74: }
                     75: </style>
                     76: </head>
                     77: <body>
                     78: <h3>nono <?=$nono_ver?></h3>
                     79: 
                     80: nono は NetBSD とかで動作する OMRON LUNA-I とかのエミュレータです。
                     81: <q>nono is OMRON LUNA-I emulator runs on NetBSD and so on.</q>
                     82: 
                     83: <hr>
                     84: <h4>ビルド方法 <q>How to build</q></h4>
                     85: <div class="main">
                     86: NetBSD/amd64-9.0 の場合以下のパッケージが必要です。
                     87: <ul>
                     88: <li>pkgsrc/x11/wxGTK30 (OPTIONS:gtk2 is recommended)
                     89: </ul>
                     90: <?php /*
                     91: Ubuntu (18.04)
                     92:  libkqueue-dev (?)
                     93: */
                     94: ?>
                     95: </dl>
                     96: アーカイブを展開したら以下のようにします。
                     97: <blockquote class="cons"><pre>
                     98: % ./configure
                     99: % make depend
                    100: % make
                    101: </pre></blockquote>
                    102: まだ make install はないです。
                    103: <tt>wx/nono</tt> が GUI 版実行ファイル、
                    104: <tt>cli/nono-cli</tt> がコマンドライン版です。
                    105: 
                    106: </div>
                    107: 
                    108: 
                    109: <h4>コマンドラインオプション <q>Command Line Option</q></h4>
                    110: <div class="main">
                    111: <dl>
                    112: <?php
                    113: function item($name, $desc)
                    114: {
                    115:        if (!is_array($name)) {
                    116:                $name = array($name);
                    117:        }
                    118:        foreach ($name as $n) {
                    119:                print "<dt class=dt-indent><tt>{$n}</tt></dt>\n";
                    120:        }
                    121:        print "<dd>{$desc}</p></dd>\n";
                    122: }
                    123: function option_item($name, $desc)
                    124: {
                    125:        item($name, $desc);
                    126: }
                    127: 
                    128: option_item("-A <i>file</i>", <<<_EOM_
                    129: ホストの <tt><i>file</i></tt> をロードして実行します。
                    130: ファイルが gzip 圧縮されていれば自動的に展開します。
                    131: (展開後の) ファイル形式は a.out (OMAGIC) か ELF で、
                    132: 実際にはブートローダとカーネル程度しか想定していません。
                    133: 設定ファイルの <tt>prom-use-rom=1</tt> とともに指定されると
                    134: <tt>-A</tt> のほうが優先します。
                    135: _EOM_
                    136: );
                    137: 
                    138: option_item("-c <i>vmdir</i>", <<<_EOM_
                    139: VM ディレクトリを指定します。省略するとカレントディレクトリとします。
                    140: _EOM_
                    141: );
                    142: 
                    143: option_item("-f", <<<_EOM_
                    144: 高速モードで起動します。
                    145: GUI なら起動後にもメニューから変更できますが、その初期値を変えるだけです。
                    146: _EOM_
                    147: );
                    148: 
                    149: option_item("--fontsize <i>height</i>", <<<_EOM_
                    150: GUI 版のみ。
                    151: 全サブウインドウの起動時のフォントサイズを指定します。
                    152: <tt><i>height</i></tt> には 12, 16, 24
                    153: のいずれかを指定します。デフォルトは <tt>12</tt> です。
                    154: _EOM_
                    155: );
                    156: 
                    157: option_item(array("-s <i>scale</i>",
                    158:        "--scale <i>scale</i>"), <<<_EOM_
                    159: GUI 版のみ。
                    160: メインウィンドウの起動時のスケールを実数で指定します。
                    161: 起動後にもメニューからプリセットされた倍率には変更可能ですが、
                    162: 任意倍率は起動時のみ指定可能です
                    163: <span class=strike>(そのうちなんとかしたい)</span>。
                    164: デフォルトは 1.0 です。
                    165: _EOM_
                    166: );
                    167: 
                    168: option_item("--show-config", <<<_EOM_
                    169: 設定ファイルと <tt>-V</tt> オプションを読み込んだ結果を表示します。
                    170: _EOM_
                    171: );
                    172: 
                    173: option_item("-v", <<<_EOM_
                    174: バージョンを表示します。
                    175: _EOM_
                    176: );
                    177: 
                    178: option_item("-V <i>name</i>=<i>value</i>", <<<_EOM_
                    179: 設定ファイルの内容を個別に上書きします。
                    180: _EOM_
                    181: );
                    182: ?>
                    183: </dl>
                    184: 
                    185: 以下開発用。
                    186: <dl>
                    187: <?php
                    188: // 項目間を空けない
                    189: function option_dev($name, $desc)
                    190: {
                    191:        print "<dt class=dt-indent><tt>{$name}</tt></dt>\n";
                    192:        print "<dd>{$desc}</dd>\n";
                    193: }
                    194: 
                    195: option_dev("-b <i>hexaddr</i>", <<<_EOM_
                    196: デバッガのブレークポイントを 16進数で指定します。
                    197: _EOM_
                    198: );
                    199: 
                    200: option_dev("-C", <<<_EOM_
                    201: ログをコンソールにも出力します。
                    202: 通常はログウィンドウにだけ出力されます。
                    203: _EOM_
                    204: );
                    205: 
                    206: option_dev("-d", <<<_EOM_
                    207: 起動時にデバッガプロンプトで停止します。
                    208: _EOM_
                    209: );
                    210: 
                    211: option_dev("-D", <<<_EOM_
                    212: コンソールをデバッガとして使用します。
                    213: -d を指定しなくても起動時にプロンプトで停止します
                    214: <span class=strike>(そのうちなんとかしたい)</span>。
                    215: _EOM_
                    216: );
                    217: 
                    218: option_dev("-L <i>name1</i>=<i>level1</i>[,<i>name2</i>=<i>level2</i>,...]",
                    219: <<<_EOM_
                    220: ログレベルを指定します。
                    221: カンマで区切って複数指定することも出来ます。
                    222: <tt>-Lhelp</tt> で name の一覧を表示します。
                    223: _EOM_
                    224: );
                    225: 
                    226: option_dev("-M <i>name</i>[,<i>name2</i>,...]", <<<_EOM_
                    227: 起動時に表示するモニタウィンドウを指定します。
                    228: カンマで区切って複数指定することも出来ます。
                    229: _EOM_
                    230: );
                    231: 
                    232: 
                    233: ?>
                    234: </dl>
                    235: </div>
                    236: 
                    237: <h4>設定 <q>Configuration</q></h4>
                    238: <div class="main">
                    239: VM の設定ファイルはその VM ディレクトリ内の nono.cfg です。
                    240: 書式は <tt>key = value</tt> 形式で1行1項目ずつです。
                    241: <tt>key</tt> と <tt>value</tt> の前後の空白は取り除かれます。
                    242: また空行と "<tt>#</tt>" で始まる行は無視します。
                    243: 知らないキーの行も無視します。
                    244: <p>
                    245: 設定項目は次の通りです。
                    246: <dl>
                    247: <?php
                    248: function config_item($name, $desc)
                    249: {
                    250:        item($name, $desc);
                    251: }
                    252: 
                    253: config_item("vmtype = <i>string</i>", <<<_EOM_
                    254: VM 種別を指定します。今の所 <tt><i>string</i></tt> に
                    255: 指定できるのは <tt>luna</tt> (LUNA-I) だけですが、省略不可です。
                    256: _EOM_
                    257: );
                    258: 
                    259: config_item("debugger-port = <i>integer</i>", <<<_EOM_
                    260: デバッガの TCP 待ち受けポート番号を指定します。
                    261: 0 なら待ち受けを行いません。
                    262: デフォルトは 9999 です(適当)。
                    263: _EOM_
                    264: );
                    265: 
                    266: config_item("ethernet-hostdriver = <i>string</i>", <<<_EOM_
                    267: イーサネットデバイスのホスト側ドライバを指定します。
                    268: <tt>none</tt>、<tt>tap</tt>、<tt>bpf</tt> が指定できます。
                    269: <tt>none</tt> ならホスト側とは一切通信を行いません。
                    270: <tt>tap</tt> か <tt>bpf</tt> かはホスト OS によってビルド時に決定します。
                    271: NetBSD なら <tt>tap</tt> です。
                    272: _EOM_
                    273: );
                    274: 
                    275: config_item("ethernet-macaddr = <i>string</i>", <<<_EOM_
                    276: イーサネットデバイスの仮想マシン側の MAC アドレスを指定します。
                    277: <tt><i>XX</i>:<i>XX</i>:<i>XX</i>:<i>XX</i>:<i>XX</i>:<i>XX</i></tt>
                    278: 形式で指定します。
                    279: <tt>auto</tt> なら自動的に決定します。
                    280: デフォルトは <tt>auto</tt> です。
                    281: _EOM_
                    282: );
                    283: 
                    284: config_item("luna-dipsw1 = <i>string</i>", <<<_EOM_
                    285: 本体前面 DIPSW#1-1..#1-8 の内容を指定します。
                    286: "<tt>0</tt>" を DOWN、"<tt>1</tt>" を UP として、
                    287: これを8つ並べた形式で、前から順に #1..#8 に対応します。
                    288: デフォルトは <tt>11110111</tt> です。
                    289: <br>
                    290: 各スイッチの内容はここ
                    291: (<a href="https://wiki.netbsd.org/ports/luna68k/luna68k_info/"
                    292: >NetBSD/luna68k: Information</a>) を参照してください。
                    293: _EOM_
                    294: );
                    295: 
                    296: config_item("luna-dipsw2 = <i>string</i>", <<<_EOM_
                    297: 本体前面 DIPSW#2-1..#2-8 の内容を指定します。
                    298: 書式は <tt>luna-dipsw1</tt> と同じです。
                    299: デフォルトは <tt>11111111</tt> です。
                    300: <br>
                    301: すべて "<tt>1</tt>"(UP) なら
                    302: NetBSD/luna68k のブートローダは自動的にカーネルをロードして実行し、
                    303: どれかでも "<tt>0</tt>"(DOWN) にするとプロンプトで停止するようです。
                    304: <span class=strike>(本当は #8 だけで制御するつもりだったんじゃないかという気がします)</span>
                    305: _EOM_
                    306: );
                    307: 
                    308: config_item("mpu-clock = <i>value</i>", <<<_EOM_
                    309: MPU のクロック数を MHz 単位で指定します。
                    310: デフォルトは 20MHz  です。
                    311: _EOM_
                    312: );
                    313: 
                    314: /* luna には不要
                    315:   config_item("mpu-has-fpu", ""); */
                    316: 
                    317: config_item("prom-use-rom = <i>integer</i>", <<<_EOM_
                    318: 外部 ROM イメージファイルを使うかどうかを指定します。
                    319: <tt>0</tt> なら使わない、<tt>1</tt> なら使うです。
                    320: デフォルトは <tt>0</tt> です。
                    321: <p>
                    322: 実機を持っていない場合はこの値を <tt>0</tt> にしておくと、
                    323: nono 内蔵のなんちゃって下位互換 ROM で起動します。
                    324: <p>
                    325: 実機を持っている場合は ROM ファイルを用意して
                    326: この値を <tt>1</tt> にすると実機 ROM で起動できます。
                    327: ROM ファイルは実機の 0x41000000-0x4101ffff (128KB) を PROM.DAT (大文字)
                    328: という名前で保存したもので、VM ディレクトリに置きます。
                    329: _EOM_
                    330: );
                    331: 
                    332: config_item("spc0-id<i>N</i>-image = <i>devtype</i>,<i>path</i>", <<<_EOM_
                    333: SCSI デバイスを指定します。<i>N</i> には 0 から 7 が入ります。
                    334: ID 7 は本体が使用しますので指定しないでください。
                    335: 値はデバイス種別 <i>devtype</i> とイメージパス <i>path</i>
                    336: を "<tt>,</tt>"(カンマ) で区切って並べた形式で、
                    337: 今の所デバイス種別 <i>devtype</i> には "<tt>hd</tt>"(ハードディスク) のみ指定可能です。
                    338: ディスクイメージパスが相対パスなら VM ディレクトリからの相対パスになります。
                    339: <p>
                    340: 例えば、nono.cfg と同じディレクトリに置いたディスクイメージ luna.img
                    341: を使う場合、
                    342: LUNA では通常 ID 6 をプライマリ HDD に割り当てるのでこんな感じになります。
                    343: <blockquote><pre>
                    344: spc0-id6-image = hd,luna.img
                    345: </pre></blockquote>
                    346: _EOM_
                    347: );
                    348: 
                    349: config_item("spc0-id<i>N</i>-writeprotect = <i>integer</i>", <<<_EOM_
                    350: 指定の SCSI デバイスへの書き込みを無視するかどうか指定します。
                    351: <tt>0</tt> なら通常動作(書き込みを行う)です。
                    352: <tt>1</tt> なら書き込みコマンドは成功したように振る舞いますが実際には
                    353: ディスクイメージに一切書き戻しません。
                    354: fsck を気にせずカーネルのデバッグとかを行いたい場合にはどうぞ。
                    355: 何が起きるか意味が分からない人は指定しないでください。
                    356: デフォルトは <tt>0</tt> です。
                    357: _EOM_
                    358: );
                    359: 
                    360: 
                    361: ?>
                    362: </dl>
                    363: </div>
                    364: 
                    365: 
                    366: <h4>実行してみる <q>Try it</q></h4>
                    367: <div class="main">
                    368: どこかに nono 用のディレクトリを用意し(例えば ~/nono/)、
                    369: その中に VM ディレクトリを用意します (例えば ~/nono/luna/)。
                    370: その中に設定ファイル nono.cfg を用意します。
                    371: nono に <tt>-c</tt> オプションで VM ディレクトリを指定して起動します。
                    372: これだけでたぶん起動して NVRAM.DAT ファイルが自動的に作られます。
                    373: ROM モニタについては最低限なんとなく雰囲気似せてあるので
                    374: 再びこちら (<a href="https://wiki.netbsd.org/ports/luna68k/luna68k_info/"
                    375: >NetBSD/luna68k: Information</a>) 参照のこと。
                    376: ここからどうやって NetBSD/luna68k をインストールするかについては待て次号。
                    377: <blockquote class="cons"><pre>
                    378: % mkdir -p ~/nono/luna/
                    379: % echo "vmtype=luna" &gt; ~/nono/luna/nono.cfg
                    380: % path/to/nono -c ~/nono/luna
                    381: </pre></blockquote>
                    382: 
                    383: </div>
                    384: 
                    385: 
                    386: <h4>ネットワーク設定 <q>Setup network</q></h4>
                    387: <div class=main>
                    388: 設定ファイルに
                    389: <blockquote class="file"><pre>
                    390: ethernet-hostdriver = tap
                    391: </pre></blockquote>
                    392: を追加し、VM ディレクトリに nono-ifup、nono-ifdown
                    393: というスクリプトを用意してください。
                    394: nono は tap(4) をオープンし、
                    395: そのデバイス名を引数にこれらのスクリプトを呼びます。
                    396: <p>
                    397: 最もシンプルなケースだとおそらく
                    398: <blockquote class="cons"><pre>
                    399: # brconfig bridge0 create
                    400: # brconfig bridge0 add wm0
                    401: </pre></blockquote>
                    402: のようにして用意しておいた bridge0 に対して、
                    403: (sudo の設定は別途行ってから)
                    404: 次のような nono-ifup、nono-ifdown を用意すれば
                    405: wm0 の物理セグメントとブリッジできると思います。
                    406: 
                    407: <blockquote>
                    408: nono-ifup
                    409: <pre class=file>
                    410: #!/bin/sh
                    411: sudo ifconfig $1 up
                    412: sudo brconfig bridge0 add $1
                    413: </pre></blockquote>
                    414: 
                    415: <blockquote>
                    416: nono-ifup
                    417: <pre class=file>
                    418: #!/bin/sh
                    419: sudo brconfig bridge0 delete $1
                    420: sudo ifconfig $1 down
                    421: </pre></blockquote>
                    422: 
                    423: </div>
                    424: 
                    425: 
                    426: <h4>注意 <q>Note</q></h4>
                    427: まだアルファリリースなので、
                    428: すべての仕様は今後互換性なく変更するかも知れません。
                    429: <q>This is alpha quality release.
                    430: All specifications on this page may be changed
                    431: without compatibility in the near future.</q>
                    432: 
                    433: <hr>
                    434: [email protected]
                    435: </body>
                    436: </html>

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.