SFD-700 mkII デベロッパーズガイド

SFD-700 mkII デベロッパーズガイド

非 VHDL プログラマー向け VHDL 入門

ソースツリー

パッケージファイル：sfd700_pkg.vhd

constant YES  : std_logic := '1';    -- アサーション：はい、真、アクティブ
constant NO   : std_logic := '0';    -- 否定：いいえ、偽、非アクティブ
constant HI   : std_logic := '1';    -- シグナルがロジックハイ（電圧）
constant LO   : std_logic := '0';    -- シグナルがロジックロウ（グランド）
constant ONE  : std_logic := '1';    -- バイナリ 1
constant ZERO : std_logic := '0';    -- バイナリ 0
constant HIZ  : std_logic := 'Z';    -- ハイインピーダンス：バスを駆動しない

constant MODE_MZ1200 : integer := 0;   -- Sharp MZ-1200（MZ-80A のエイリアス）
constant MODE_MZ80A  : integer := 0;   -- Sharp MZ-80A
constant MODE_MZ700  : integer := 1;   -- Sharp MZ-700
constant MODE_MZ80B  : integer := 2;   -- Sharp MZ-80B
constant MODE_MZ800  : integer := 3;   -- Sharp MZ-800
constant MODE_MZ1500 : integer := 4;   -- Sharp MZ-1500
constant MODE_MZ2000 : integer := 5;   -- Sharp MZ-2000
constant MODE_MZ2200 : integer := 6;   -- Sharp MZ-2200

トップレベルファイル：sfd700_Toplevel.vhd

architecture rtl of sfd700 is
begin
    cpldl128Toplevel : entity work.cpld128
    port map
    (
        Z80_ADDR    => Z80_ADDR,
        Z80_DATA    => Z80_DATA,
        Z80_M1n     => Z80_M1n,
        Z80_RDn     => Z80_RDn,
        ...
        CLK_16M     => CLK_16M,
        CLK_FDC     => CLK_FDC,
        CLK_BUS0    => CLK_BUS0
    );
end architecture;

メインロジックファイル：sfd700.vhd

entity cpld128 is
    port (
        -- Z80 アドレスバス
        Z80_ADDR    : in    std_logic_vector(15 downto 0);  -- ホスト Z80 からの 16 ビットアドレス
        -- Z80 データバス（双方向）
        Z80_DATA    : inout std_logic_vector(7 downto 0);   -- 8 ビットデータ — 駆動または読み取り可能
        -- Z80 制御シグナル
        Z80_M1n     : in    std_logic;   -- マシンサイクル 1（アクティブロウ）— Z80 がオペコードをフェッチ中
        Z80_RDn     : in    std_logic;   -- 読み取りストローブ（アクティブロウ）
        Z80_WRn     : in    std_logic;   -- 書き込みストローブ（アクティブロウ）
        Z80_IORQn   : in    std_logic;   -- I/O リクエスト（アクティブロウ）
        Z80_MREQn   : in    std_logic;   -- メモリリクエスト（アクティブロウ）
        Z80_INT     : out   std_logic;   -- Z80 への割り込み（アクティブハイ）
        Z80_EXWAITn : out   std_logic;   -- 外部ウェイト（アクティブロウ、バスサイクルを延長）
        Z80_RESETn  : in    std_logic;   -- システムリセット（アクティブロウ）
        -- 反転データ / ROM-RAM 上位アドレスバス
        ID          : inout std_logic_vector(7 downto 0);   -- 二重目的：反転 FDC データまたは ROM/RAM 上位アドレス
        -- ROM/RAM 制御
        ROM_A10     : out   std_logic;   -- ROM ページビット / MZ-80A DRQ マルチプレクサ
        RAM_A10     : out   std_logic;   -- RAM ページビット
        ROM_CSn     : out   std_logic;   -- フラッシュ ROM チップセレクト（アクティブロウ）
        RAM_CSn     : out   std_logic;   -- SRAM チップセレクト（アクティブロウ）
        RSV         : out   std_logic;   -- 予約済み出力ピン
        -- ホストマシンモード
        MODE        : in    std_logic_vector(2 downto 0);   -- 3 ビットモードジャンパー
        -- フロッピーディスクインターフェース
        FDCn        : out   std_logic;   -- WD1773 チップセレクト（アクティブロウ）
        INTRQ       : in    std_logic;   -- WD1773 コマンド完了割り込み
        DRQ         : in    std_logic;   -- WD1773 データリクエスト
        DDENn       : out   std_logic;   -- ダブル密度有効化（アクティブロウ）
        SIDE1       : out   std_logic;   -- ディスクヘッドサイド選択
        MOTOR       : out   std_logic;   -- スピンドルモーター有効化
        DRVSAn      : out   std_logic;   -- ドライブ A チップセレクト（アクティブロウ）
        DRVSBn      : out   std_logic;   -- ドライブ B チップセレクト（アクティブロウ）
        DRVSCn      : out   std_logic;   -- ドライブ C チップセレクト（アクティブロウ）
        DRVSDn      : out   std_logic;   -- ドライブ D チップセレクト（アクティブロウ）
        -- クロック
        CLK_16M     : in    std_logic;   -- 16 MHz 水晶発振器
        CLK_FDC     : out   std_logic;   -- WD1773 への 8 MHz
        CLK_BUS0    : in    std_logic    -- ホスト Z80 バスクロック（予約済み）
    );
end entity;

-- アドレスデコード選択シグナル（内部ワイヤー、物理ピンではない）
signal FDC_SELni        : std_logic;   -- WD1773 レジスタにアクセス中に '0'
signal DRIVE_WR_SELni   : std_logic;   -- ポート 0xDC に書き込み中に '0'
signal DDEN_WR_SELni    : std_logic;   -- ポート 0xDE に書き込み中に '0'
signal SIDE_WR_SELni    : std_logic;   -- ポート 0xDD に書き込み中に '0'
signal INTEN_SELni      : std_logic;   -- ポート 0xDF にアクセス中に '0'
signal EXXX_WR_SELni    : std_logic;   -- ポート 0x60 に書き込み中に '0'
signal FXXX_WR_SELni    : std_logic;   -- ポート 0x61 に書き込み中に '0'
signal MEM_EXXX_SELni   : std_logic;   -- メモリアドレスが E300h-EFFFh の時に '0'
signal MEM_FXXX_SELni   : std_logic;   -- メモリアドレスが F000h-FFFFh の時に '0'

-- 登録状態（これらは CPLD 内のフリップフロップになる）
signal REG_DRIVEA       : std_logic;   -- ドライブ A 選択
signal REG_DRIVEB       : std_logic;   -- ドライブ B 選択
signal REG_DRIVEC       : std_logic;   -- ドライブ C 選択
signal REG_DRIVED       : std_logic;   -- ドライブ D 選択
signal REG_MOTOR        : std_logic;   -- モーター動作中
signal REG_SIDE         : std_logic;   -- ディスクヘッドサイド
signal REG_DDEN         : std_logic;   -- ダブル密度モードアクティブ
signal REG_INT          : std_logic;   -- 割り込み有効
signal REG_EXXX_PAGE    : std_logic_vector(7 downto 0);   -- 8 ビット EXXX ページレジスター（D7=ROM/RAM 選択、[6:0]=ページアドレス）
signal REG_FXXX_PAGE    : std_logic_vector(7 downto 0);   -- 8 ビット FXXX ページレジスター（D7=ROM/RAM 選択、[6:0]=ページアドレス）
signal REG_ROMDIS       : std_logic;   -- MZ-700：ROM 無効（DRAM マッピング）
signal REG_ROMINH       : std_logic;   -- MZ-700：ROM 完全禁止

-- マシンモード（リセット時にジャンパーからキャプチャ）
signal IFMODE           : integer range 0 to 7 := 0;

-- クロック
signal CLK_8Mi          : std_logic := '0';   -- 8 MHz 分周クロック（内部）

プロセス：FDCCLK — クロック分周器

FDCCLK: process( CLK_16M )
begin
    if(rising_edge(CLK_16M)) then
        CLK_8Mi <= not CLK_8Mi;
    end if;
end process;

プロセス：SETMODE — モードレジスタラッチ

SETMODE: process( Z80_RESETn, MODE )
begin
    if(Z80_RESETn = '0') then
        IFMODE <= to_integer(unsigned(MODE));
    end if;
end process;

プロセス：SETSIDE — ヘッドサイドレジスタ

SETSIDE: process( Z80_RESETn, CLK_16M, SIDE_WR_SELni )
    variable SIDE_SEL_LASTni : std_logic;
begin
    if(Z80_RESETn = '0') then
        REG_SIDE        <= '0';
        SIDE_SEL_LASTni := '0';
    elsif(rising_edge(CLK_16M)) then
        if(SIDE_WR_SELni = '0' and SIDE_SEL_LASTni = '1') then
            REG_SIDE    <= not Z80_DATA(0);
        end if;
        SIDE_SEL_LASTni := SIDE_WR_SELni;
    end if;
end process;

プロセス：SETDDEN — ダブル密度有効化

SETDDEN: process( Z80_RESETn, CLK_16M, DDEN_WR_SELni )
    variable DDEN_SEL_LASTni : std_logic;
begin
    if(Z80_RESETn = '0') then
        REG_DDEN        <= '1';
        DDEN_SEL_LASTni := '0';
    elsif(rising_edge(CLK_16M)) then
        if(DDEN_WR_SELni = '0' and DDEN_SEL_LASTni = '1') then
            REG_DDEN    <= not Z80_DATA(0);
        end if;
        DDEN_SEL_LASTni := DDEN_WR_SELni;
    end if;
end process;

プロセス：SETDRIVE — ドライブとモーター制御

SETDRIVE: process( Z80_RESETn, CLK_16M, DRIVE_WR_SELni )
    variable DRIVE_SEL_LASTni: std_logic;
begin
    if(Z80_RESETn = '0') then
        REG_DRIVEA <= '0'; REG_DRIVEB <= '0';
        REG_DRIVEC <= '0'; REG_DRIVED <= '0';
        REG_MOTOR  <= '0';
        DRIVE_SEL_LASTni := '0';
    elsif(rising_edge(CLK_16M)) then
        if(DRIVE_WR_SELni = '0' and DRIVE_SEL_LASTni = '1') then
            REG_DRIVEA <= '0'; REG_DRIVEB <= '0';
            REG_DRIVEC <= '0'; REG_DRIVED <= '0';
            REG_MOTOR  <= Z80_DATA(7);
            case(to_integer(unsigned(Z80_DATA(2 downto 0)))) is
                when 0 =>                          -- ドライブなし
                when 4 => REG_DRIVEA <= '1';       -- ドライブ A を選択
                when 5 => REG_DRIVEB <= '1';       -- ドライブ B を選択
                when 6 => REG_DRIVEC <= '1';       -- ドライブ C を選択
                when 7 => REG_DRIVED <= '1';       -- ドライブ D を選択
                when others =>
            end case;
        end if;
        DRIVE_SEL_LASTni := DRIVE_WR_SELni;
    end if;
end process;

プロセス：SETINT — 割り込み有効レジスタ

SETINT: process( Z80_RESETn, CLK_16M, INTEN_SELni )
    variable INTEN_SEL_LASTni: std_logic;
begin
    if(Z80_RESETn = '0') then
        REG_INT          <= '0';
        INTEN_SEL_LASTni := '0';
    elsif(rising_edge(CLK_16M)) then
        if(INTEN_SELni = '0' and INTEN_SEL_LASTni = '1') then
            REG_INT      <= Z80_RDn;
        end if;
        INTEN_SEL_LASTni := INTEN_SELni;
    end if;
end process;

プロセス：SETEXXXPAGE — EXXX ウィンドウページレジスタ

SETEXXXPAGE: process( Z80_RESETn, CLK_16M, IFMODE, EXXX_WR_SELni )
    variable EXXX_SEL_LASTni : std_logic;
begin
    if(Z80_RESETn = '0') then
        REG_EXXX_PAGE    <= "00000010";   -- Reset to page 2 (D7=0 → Flash ROM, [6:0]=page 2 RFS start bank)
        EXXX_SEL_LASTni  := '0';
    elsif(rising_edge(CLK_16M)) then
        if(EXXX_WR_SELni = '0' and EXXX_SEL_LASTni = '1') then
            REG_EXXX_PAGE <= Z80_DATA(7 downto 0);
        end if;
        EXXX_SEL_LASTni  := EXXX_WR_SELni;
    end if;
end process;

プロセス：SETFXXXPAGE — FXXX ウィンドウページレジスタ

SETFXXXPAGE: process( Z80_RESETn, CLK_16M, IFMODE, FXXX_WR_SELni )
    variable FXXX_SEL_LASTni : std_logic;
begin
    if(Z80_RESETn = '0') then
        REG_FXXX_PAGE    <= (others => '0');    -- Default: D7=0 (Flash ROM), page 0 (MZ-80A AFI ROM)
        if(IFMODE = MODE_MZ700) then
            REG_FXXX_PAGE(1 downto 0) <= "01"; -- MZ-700: page 1 (MZ-700 AFI ROM)
        end if;
    elsif(rising_edge(CLK_16M)) then
        if(FXXX_WR_SELni = '0' and FXXX_SEL_LASTni = '1') then
            REG_FXXX_PAGE <= Z80_DATA(7 downto 0);
        end if;
        FXXX_SEL_LASTni  := FXXX_WR_SELni;
    end if;
end process;

RAM / ROM 選択（ページレジスタービット 7 経由）

プロセス：SETHIMEM — MZ-700 / MZ-1500 メモリ管理

並行シグナル割り当て

MEM_EXXX_SELni <= '0' when Z80_MREQn = '0'
                       and unsigned(Z80_ADDR(15 downto 8)) >= X"E3"
                       and unsigned(Z80_ADDR(15 downto 8)) < X"F0"
                  else '1';

MEM_FXXX_SELni <= '0' when Z80_MREQn = '0'
                       and unsigned(Z80_ADDR(15 downto 8)) >= X"F0"
                       and unsigned(Z80_ADDR(15 downto 8)) <= X"FF"
                  else '1';

ROM_SELni <= '0' when (IFMODE = MODE_MZ700 or IFMODE = MODE_MZ1500)
                       and REG_ROMINH = '0' and REG_ROMDIS = '0'
                       and ((MEM_EXXX_SELni = '0' and REG_EXXX_PAGE(7) = '0')
                            or (MEM_FXXX_SELni = '0' and REG_FXXX_PAGE(7) = '0'))
             else
             '0' when (IFMODE = MODE_MZ1200 or IFMODE = MODE_MZ80A)
                       and ((MEM_EXXX_SELni = '0' and REG_EXXX_PAGE(7) = '0')
                            or (MEM_FXXX_SELni = '0' and REG_FXXX_PAGE(7) = '0'))
             else '1';

FDC_SELni <= '0' when Z80_IORQn = '0'
                       and (Z80_WRn = '0' or Z80_RDn = '0')
                       and unsigned(Z80_ADDR(7 downto 0)) >= X"D8"
                       and unsigned(Z80_ADDR(7 downto 0)) < X"DC"
             else '1';

DRIVE_WR_SELni <= '0' when Z80_IORQn = '0' and Z80_WRn = '0'
                       and unsigned(Z80_ADDR(7 downto 0)) = X"DC"
                  else '1';

Z80_DATA <= not ID                         when FDC_SELni = '0' and Z80_WRn = '1'
            else REG_EXXX_PAGE             when EXXX_RD_SELni = '0'
            else REG_FXXX_PAGE             when FXXX_RD_SELni = '0'
            else "00000" & MODE            when MODE_RD_SELni = '0'
            else (others => 'Z');

ID <= not Z80_DATA                                when Z80_WRn = '0' and FDC_SELni = '0'
     else REG_EXXX_PAGE(6 downto 0) & Z80_ADDR(11)  when MEM_EXXX_SELni = '0'
     else REG_FXXX_PAGE(6 downto 0) & Z80_ADDR(11)  when MEM_FXXX_SELni = '0'
     else (others => 'Z');

ROM_A10 <= '1' when (IFMODE = MODE_MZ1200 or IFMODE = MODE_MZ80A) and DRQ = '1'
           else Z80_ADDR(10);

CPLD ロジックの変更

GAL CUPL ロジック（v1.0 / v1.1）

CI/CD パイプライン

Jenkins パイプライン概要

1. Checkout — ワークスペースをクリーンし、Gitea から SFD700 リポジトリをクローン。
2. Determine Version — リポジトリルートの VERSION ファイルを読み取る。前回のコミットからバージョンが変更されていない場合、最新の Gitea リリースタグからバージョン番号を自動的にインクリメント。
3. Build CPLD — Docker コンテナ内の Altera Quartus II 13.0.1 を使用して VHDL ソースをコンパイルし、EPM7128SLC84-15 CPLD 用の sfd700.pof ビットストリームを生成。
4. Clone RFS — Gitea から RFS（ROM ファイリングシステム）リポジトリをクローン。RFS は複数のハードウェアプラットフォーム（RomDisk、SFD700、picoZ80）で共有されるため、別プロジェクトとして管理されている。
5. Build RFS for SFD700 — RFS アセンブリ定義の BUILD_SFD700 フラグを設定し、GLASS アセンブラを使用して Z80 ROM コードをコンパイル。生成された ROM イメージは SFD700 ROM レイアウトに従ってパッケージ化。
6. Package Releases — CPLD ビットストリーム、ROM イメージ、および結合完全パッケージの 3 つのリリースアーカイブを作成。
7. Create Gitea Release — リリースアーティファクトをバージョン番号でタグ付けされた新しい Gitea リリースにアップロード。

Webhook 設定

• Webhook URL — http://<jenkins-container-ip>:8080/generic-webhook-trigger/invoke?token=sfd700-build-trigger
• トークン — sfd700-build-trigger
• コンテンツタイプ — application/json
• ブランチフィルター — refs/heads/main または refs/heads/master へのプッシュのみトリガー。フィーチャーブランチ、タグ、その他の ref へのプッシュは無視される。

バージョン管理

• VERSION がトリガーコミットで変更されている場合、ファイルに指定されたバージョンがそのままリリースに使用される。
• VERSION が未変更の場合、パイプラインは Gitea API で最新リリースタグを照会し、マイナーバージョン番号を自動インクリメント。
• マイナーバージョンは 100 でロールオーバー：バージョン 1.99 は 2.00 にインクリメント（メジャーバージョンが 1 増加、マイナーが 00 にリセット）。
• VERSION ファイルが存在せず、以前のリリースも見つからない場合、バージョンはデフォルトで 1.00 になる。

CPLD ビルドステージ

// サイドカーコンテナボリュームの Groovy パスマッピング
def workspace = pwd()
def hostWorkspace = workspace.replace('/var/jenkins_home', '/srv/jenkins/data')

// ホストパスマッピングを使用してサイドカーコンテナで Quartus を実行
docker run --rm --net=host \
    -v "${hostWorkspace}:${workspace}" \
    -w "${workspace}/CPLD/v1.2/build" \
    quartus-ii-13.0.1 \
    /opt/altera/quartus/bin/quartus_sh --flow compile sfd700

RFS ビルドステージ

; RFS ビルドターゲットフラグ（一度に 1 つのみ 1 に設定する必要がある）
BUILD_ROMDISK                    EQU     0       ; MZ-80A RomDisk ハードウェア
BUILD_SFD700                    EQU     1       ; SFD-700 mkII フロッピーアダプター
BUILD_PICOZ80                    EQU     0       ; picoZ80 エミュレーターボード

1. assemble_rfs.sh — GLASS を使用して rfs.asm および rfs_mrom.asm をアセンブルし、roms/ ディレクトリに rfs.rom と rfs_mrom.rom を生成。
2. assemble_cpm.sh — CP/M 関連 ROM をアセンブル（ビルドターゲットに該当する場合）。
3. assemble_roms.sh — 追加 ROM イメージをアセンブル。
4. make_roms.sh — アセンブルされた ROM を最終的な SFD700 ROM イメージにパッケージ化。SFD700 ROM レイアウトは 256KB の複合イメージです：

   SFD700 ROM レイアウト（256KB）：
   0x00000-0x00FFF  MZ-80A フロッピー ROM（mz80afi_sfd700.rom、ミラーリング）
   0x01000-0x01FFF  MZ-1E05 MZ-700 フロッピー ROM（mz-1e05.rom）
   0x02000-0x0BFFF  RFS rfs.rom（40KB ROM ファイリングシステム）
   0x0C000-0x7FFFF  USER / ROM ファイルシステムストレージ
   

リリースアーティファクト

パイプライン設定

• Jenkins コンテナ — jenkins_jenkins_1 として実行され、/var/jenkins_home がホストの /srv/jenkins/data にマップ。
• Quartus Docker イメージ — quartus-ii-13.0.1、MAX7000S デバイスサポートを含む Altera Quartus II 13.0.1 を含むビルド済みイメージ。FusionX パイプラインと共有。
• Gitea インスタンス — git.eaw.app で SFD700 および RFS リポジトリをホスト。
• 初期化スクリプト — /var/jenkins_home/init.groovy.d/ に配置された Groovy スクリプトで、Jenkins 起動時にパイプラインジョブを作成および設定。
• パイプラインスクリプト — /var/jenkins_home/pipeline-scripts/ に配置され、初期化スクリプトによって読み込まれる完全な Groovy パイプライン定義を含む。

手動ビルドトリガー

# ビルドを手動でトリガー
curl -X POST \
    -H "Content-Type: application/json" \
    -d '{"ref": "refs/heads/main"}' \
    "http://<jenkins-ip>:8080/generic-webhook-trigger/invoke?token=sfd700-build-trigger"

メール通知

• 成功 — 件名：「SFD700 Build vX.XX - SUCCESS」、ビルドバージョン、ジョブ名、ビルド番号、URL を含む。
• 失敗 — 件名：「SFD700 Build - FAILED」、ジョブ URL と詳細はコンソール出力を確認する旨のメモを含む。

参考サイト