Skip to content

Latest commit

 

History

History
216 lines (181 loc) · 11.2 KB

MANUAL.md

File metadata and controls

216 lines (181 loc) · 11.2 KB

Free386 User's Manual

This software is a DOS-Extender that is compatible with Phar-Lap RUN386. This is works with "FM TOWNS" and "PC-9801(9821)" and "AT compatible machines".

  • This software can run .EXP format (P3 or MP format) files on DOS.
  • Requires an XMS 3.0 memory server (HIMEM.SYS 3.xx) to run.
    • It can also be used in VCPI environment (EMM386.EXE or other).
    • In non-VCPI environments, the amount of physical memory is an estimate (excluding TOWNS version).
    • You can use it with XMS 2.0 by defining USE_XMS20 and reassembling it.
    • [TOWNS] TownsOS does not require XMS/VCPI (HIMEM.SYS, EMM386.EXE).
  • Basically, it complies with Ver1.2, which is the version of RUN386 for TOWNS.

このソフトは、Phar-Lap RUN386 互換の DOS-Extender です。 FM TOWNS / PC-98x1 / AT互換機で動作します。

  • このソフトは .EXP 形式（P3 or MP形式）のファイルを実行することができます。
  • 実行には XMS 3.0 メモリサーバ（HIMEM.SYS 3.xx）が必要です。
    • VCPI環境（EMM386.EXE or other）でも使用できます。
    • TOWNS版以外では、非VCPI環境で物理メモリ量が推定値になります。
    • USE_XMS20 を定義して再アセンブルすれば、XMS 2.0環境でも使用できます。
    • [TOWNS] TownsOS使用時、XMS/VCPI (HIMEM.SYS, EMM386.EXE) はなくても大丈夫です。
  • 基本的に、TOWNS用RUN386のバージョンである、Ver1.2に準拠しています。

Usage

> free386 [-options] <target.exp>
  • Displays help if no arguments are specified.
  • The executable file extension ".exp" can be omitted.
  • Automatically searches for executable files by referring to the environment variable PATH386.
  • 引数を指定しない場合、ヘルプを表示します。
  • 実行ファイルの拡張子 ".exp" は省略できます。
  • 環境変数 PATH386 を参照し、実行ファイルを自動検索します。

Options

  • -v
    • Verbose. Mainly displays information about memory.
  • -vv
    • More verbose.
  • -q
    • Do not output Free386's title and help.
  • -p0 (default)
  • -p1
    • -p1 After the environment variable PATH386, the environment variable PATH to find the EXP executable file.
  • -m
    • Memory pages reserved for paging are set to 0.
    • Real memory reserved for DOS is set to 0 bytes and allocate as much memory as possible for "EXP" file.
    • User call buffer pages set to 1 (=4KB).
    • Note) DOS free memory is not completely 0 bytes due to 4KB fragmentation.
  • -2
    • Set Phar Lap's DOS-Extender Version information to "2.2". Usually "1.2".
  • -c0
  • -c1, -c
  • -c2
  • -c3 (default)
    • Set automatic reset of CRTC and VRAM. This function is only implemented in FM TOWNS and PC-98.
    • -c0 Not initialize.
    • -c1 Always initialize.
    • -c2 Initialize only the screen mode.
    • -c3 Automatically detect and initialize if necessary.
  • -i0, -i
  • -i1 (default)
    • -i1 Auto detect machines type for prevents execution of Free386 binaries on different machines.
  • -n (only TOWNS)
    • Do not initialize CoCo/NSD driver. Improved execution speed for EXP files that do not require CoCo.
  • -maxreal nn
    • Set minimum dos free memory "nn [byte]". Actually, it is set in 1KB units.
  • -minreal nn
    • Set maximum dos free memory "nn [byte]". Actually, it is set in 1KB units.
  • -callbuf nn
    • Set user call buffer size "nn [KB]". Actually, it is set in 4KB units. If set to 0, This will be the same as Free386's internal call buffer.

Options (in Japanese)

  • -v
    • メモリに関する情報を表示します。
  • -vv
    • より冗長な表示を行います。
  • -q
    • Free386のタイトルとヘルプを表示しない。
  • -p0 (default)
  • -p1
    • -p1 環境変数PATH386の次に、環境変数PATHを参照して EXP実行ファイルを検索します。
  • -m
    • ページテーブル用の予備メモリページ数を「0」に設定します。
    • DOS用に空けておくメモリを0バイトに設定し、可能な限り多くのメモリをEXP用に割り当てます。
    • ユーザーコールバッファのページ数を「1（=4KB）」に設定します。
    • ※メモリは4KB単位でしか使用できないため、DOS空きメモリは「0 byte」にはなりません。
  • -2
    • Phar Lap DOS-Extender Versionを "2.2" に設定します。通常は "1.2" です。
  • -c0
  • -c1
  • -c2
  • -c3 (default)
    • CRTCやVRAMの自動リセットを設定します。この機能は FM TOWNS 及び PC-98 のみ実装されています。
    • -c0 初期化しない。
    • -c1 常に初期化する。
    • -c2 画面モードのみ初期化する。
    • -c3 初期化するかは自動判別する。
  • -i, -i0
  • -i1 (default)
    • -i1 実行時機種判別を行い、機種の異なるFree386バイナリの実行を防止します。
  • -n (only TOWNS)
    • CoCo/NSD ドライバの初期化を行わず、CoCoが不要なEXPファイルにおいて動作速度を向上させます。
  • -maxreal nn
    • DOSフリーメモリの最大値を「nn [byte]」に設定します。実際は 1KB 単位で設定されます。
  • -minreal nn
    • DOSフリーメモリの最小値を「nn [byte]」に設定します。実際は 1KB 単位で設定されます。
  • -callbuf nn
    • ユーザーコールバッファのサイズを「nn [KB]」に設定します。実際は 4KB 単位で設定されます。0に設定すると、Free386内部コールバッファと共通になります。

Binary Hack for default setting

free386.com has behavior definition variables at the beginning of the file, and you can change the default behavior by rewriting them. Please use your favorite binary editor for rewriting.

free386.com はファイル先頭に動作定義変数を持っており、書き換えることでデフォルトの動作を変更できます。 書き換えにはお好みのバイナリエディタを使用してください。

offset default size detail
+04h 1 b Show Free386's title: 0=off, 1=on
+05h 0 b Performs verbose: 0=off, 1=on, 2=more verbose (See -v option)
+06h 1 b Find target exp file from PATH386 of enviroment variable: 0=off, 1=on
+07h 0 b Find target exp file from PATH of enviroment variable: 0=off, 1=on (See -p option)
+08h 3 b Auto CRTC/VRAM clear. (See -c option)
+09h 1 b Auto detect machines type: 0=off, 1=on (See -i option)
+0ah 0 b Descending extended memory mapping: 0=off, 1=on
+0bh 0 b (Reserved)
+0ch 2 b Reserved memory pages for paging table (unit is page). 1page=4KB.
+0dh 32 b Call buffer size (KB). Use 16bit<->32bit function call. min 4KB. Reducing this value does not increase free memory. Because, this memory allocate from Free386 internal 64KB memory.
+0eh 8 b Reserved minimum DOS memory(KB).
+10h 4 b User's call buffer pages for ax=250Dh/ax=2517h. If set to 0, it will be the same as the internal call buffer. 1page=4KB. [TOWNS] If you run TownsMENU, this will need at least 4 pages (=16KB).

In addition, if you want to rewrite the default value of Phar Lap's DOS-Extender Version information, search for the string "12aJ" (31 32 61 4A) and rewrite it to "22d " (32 32 64 20) or other.

位置 標準 size 詳細l
+04h 1 b 実行時にFree386のタイトルを表示します: 0=off, 1=on
+05h 0 b 実行時にメモリ情報等を表示します: 0=off, 1=on, 2=多く表示
+06h 1 b 環境変数PATH386の中から実行対象のEXPファイルを検索します: 0=off, 1=on
+07h 0 b 環境変数PATHの中から実行対象のEXPファイルを検索します: 0=off, 1=on
+08h 3 b 自動 CRTC/VRAM 初期化の初期値を設定します（"-c"オプション参照）
+09h 1 b 機種判別機能を実行します: 0=off, 1=on （"-i"オプション参照）
+0ah 0 b 1MB以上の拡張メモリを貼り付けるとき、降順で物理メモリを使用します: 0=off, 1=on
+0bh 0 b （予約済）
+0ch 2 b ページングテーブル用の予約済ページ数。1ページ=4KB。
+0dh 32 b コールバッファサイズをKB単位で設定します。最小は4KBです。このメモリはFree386本体の64KB領域から確保されるため、この値を減らしてもフリーメモリは増えません。
+0eh 8 w 空けておくDOSメモリをKB単位で設定します。
+10h 4 b ユーザー用コールバッファをページ単位で設定します。int 21h, ax=250Dh/ax=2517h で返されるバッファです。0に設定すると、内部コールバッファをユーザーに返すようになります。[TOWNS] TownsMENUを起動するには最低4ページ（16KB）必要です。

その他、Phar Lap DOS-Extender Versionのデフォルト値を書き換えたいときは、 "12aJ"(31 32 61 4A) を文字列検索し、"22d "(32 32 64 20) 等に書き換えてください。

Support Functions

  • int 21h, AH=25h
    • AX=2501h-250Ah, 250Ch-2515h, 2517h, 25C0h-25C2h
  • int 21h (DOS and DOSX)
    • AH=00h-0Eh, 19h-1Ch, 2Ah-31h, 33h, 34h, 36h, 38-4Ah, 4Ch-4Fh, 52h, 54h, 56h-5Ch, 62h, 67h
  • int 20h, int 29h
  • int 2fh (chain to DOS int 2fh)
  • Free386 original functions
    • int 9ch: Free386 extend functions
    • int ffh: Register dump service function

If you have requests for implementation, please contact us.

もし実装してほしいファンクションの要望がありましたらご連絡ください。

Unimplemented Functions (implemented in RUN386)

  • int 21h
    • AX=2512h - LOAD PROGRAM FOR DEBUGGING
    • AH=32h - GET DOS DRIVE PARAMETER BLOCK FOR SPECIFIC DRIVE
    • AH=4Bh or AX=25C3h - EXEC - LOAD AND/OR EXECUTE PROGRAM

未実装ファンクション。

  • int 21h
    • AX=2512h - デバッグ用のEXPファイルロード
    • AH=32h - 指定ドライブのディスクパラメーター(DPB)取得
    • AH=4Bh or AX=25C3h - DOSの子プロセスを起動

Incompatible Functions

  • int 21h
    • AH=09h: Print string. If the data size exceeds the "call buffer size", the excess data will be truncated.
    • AH=44h: IOCTL. Functions use buffers are not supported.

非互換ファンクション。

  • int 21h
    • AH=09h: 文字列出力。データがコールバッファサイズを越えた場合、超えたデータは無視される。
    • AH=44h: IOCTL。バッファを使用するものは未サポート。

Known issues

  • Usable memory is limited to a maximum of 1GB.
  • When setting the EXP file name to the ENV command name, it will be truncated if there is not enough space.
  • EXP linker options "-maxreal, -minreal, -callbuf" are ignored.
  • After creating two selectors using int 21h/AH=48h, if you expand the first selector beyond 2MB, the linear address of the second selector may overlap and memory corruption may occur.
  • 使用できるメモリが最大1GBに制限されています。
  • ENV領域のコマンド名にEXPファイル名を設定する際、領域が足りないときはファイル名が途中で切り捨てられます。
  • EXPリンカオプションの「-maxreal, -minreal, -callbuf」は無視されます。
  • int 21h/AH=48h を使用し2つのセレクタを作成後、1つ目のセレクタを4MBを超えて拡張すると、2つ目のセレクタとリニアアドレスが重複し、メモリ破壊が起こることがあります。