8bit自作ゲーム機（VGS-Zero）でほぼ遅延無く確実に動くジョイパッドに対応

# はじめに

前回記事「Z80+C言語で16ビット機級の本格的なゲームが創れるゲーム機（VGS-Zero）を作ってみた」で想定以上に多くの反響を頂き、有り難いことに多くの方に VGS-Zero を触っていただくことができました。

https://qiita.com/suzukiplan/items/8a740b593816ef9ef565

上記記事を公開前は 100+ 程度あった[RaspberryPi Zero 2W のスイッチサイエンスの在庫](https://www.switch-science.com/products/7600)が、記事を公開後に一気に無くなってしまいました。多分偶然だと思いますが、万が一私の記事の影響だったら何かスミマセン...（2024.02.14本日時点では在庫が復活しているようです）

_今回の記事はそんなに伸びないと思うので大丈夫な筈。_

触っていただいた方から、「接続しても反応しない USB ジョイパッドがあった」というご報告があったので早速同じ機種の USB ジョイパッドを購入してテストしてみたのですが、報告の通り全く反応がありませんでした。

> なお、ジョイパッドにはジョイカード、ジョイスティック、ゲームパッド、ゲームコントローラー、コントローラーなどの様々な呼び方がありますが、本書では表記ゆれ回避のためすべて「ジョイパッド」と表記します。

その USB ジョイパッドは XInput と DirectInput の両モードに対応していて、本体背面のスイッチで切り替えるタイプのものですが、それぞれのモードについて VGS-Zero のリポジトリで提供している [USB ジョイパッドの反応テストツール](https://github.com/suzukiplan/vgszero/tree/master/tools/joypad) でテストしてみたところ、何となく動かない原因が分かりました。

__（DirectInput モードの場合）__

```
usbdev0-1: Device ven46d-c216 found (FS)
usbdev0-1: Product: <<<ややネガティブ情報かもしれないのでメーカー名は伏せておきます>>>
usbdev0-1: Interface int3-0-0 found
usbdev0-1: Using device/interface int3-0-0
dwhci: Transaction failed (status 0x402)
kernel: USB joypad connected
```

デバイスの接続自体は認識できています。

しかし、ボタンやカーソルを押しても何も反応しません。

VGS-Zero（Circle）で使用可能なジョイパッドの場合、ボタンやカーソルを押すと下図のように `Push BUTTON_n detected` や `Changed AXIS_n = nnn` といったレコード（config.sys への設定値）を出力するのですが、問題のジョイパッドではどのボタンを押しても何も出力されません。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2161417/5c38f5c9-2ddf-f3a6-9ea4-32399bb92df0.png)

そこで、問題のジョイパッドのマニュアルを熟読してみたところ、__DirectInput モードの場合は専用のデバイスドライバをインストールする必要がある__ との記述がありました。つまり、問題のジョイパッドの USB 通信プロトコルは標準 HID に準拠しておらず、独自プロトコルで実装されているものと考えられます。

USB 通信プロトコルは大きなオーバーヘッドを要するものなので、各メーカーで工夫した独自プロトコルを使うことで少しでも遅延を少なくする努力をしているのかもしれません。しかし、デバイスドライバが無ければカーネル側が入力を認識できないため、動作させるには専用のデバイスドライバが必要になります。

当然ながら VGS-Zero 用のデバイスドライバ提供されていないので、このゲームパッドを VGS-Zero (RaspberryPi Zero 2W) で動かすことはできません。

そこで、標準 HID 準拠のジョイパッド以外は使用できない旨を VGS-Zero のドキュメントに記載しておきました。

__（XInput モードの場合）__

```
usbdev0-1: Device ven46d-c21d found (FS)
usbdev0-1: Product: <<<ややネガティブ情報かもしれないのでメーカー名は伏せておきます>>>
usbdev0-1: Function is not supported
usbdev0-1: Device has no supported function
usbdev0-1: Device ven46d-c21d removed
dwhci: Cannot initialize root port
```

DirectInput モードとは異なり、デバイスが Circle で非サポートの機能を使っているため認識できないようです。

XInput については、Windows と XBOX であればほぼ問題なく（デバイスドライバ無しで）動作できます。しかし、XInput のプロトコル仕様を調べてみたのですが、ザックリと調べてみた限りでは見つからなかったため、完全にオープンなプロトコル仕様ではないようです。そのため、Windows と XBOX 以外での動作が不完全になりがちなのかもしれません。

そのような事情から、VGS-Zero では XInput のジョイパッドの使用は __基本的に非推奨__ となります。VGS-Zero では、先述の通り __標準 HID 準拠のジョイパッドのみ推奨__ というのが基本スタンスになります。

ただし、標準 HID 準拠のジョイパッドは EOL の製品が多いという難点があります。個人的に一番オススメできるのは [Elecom の JC-3312S シリーズ](https://www2.elecom.co.jp/peripheral/gamepad/jc-u3312s/)ですが、もちろん EOL で後継製品も存在しないようです。そういった製品は Aliexpress で模造品が出回ることを期待するしかありません。

ジョイパッドはゲームにとってかなり重要な構成要素だと私は考えています。

そのため、ジョイパッドの入力問題はクリティカルです。

私が実際に購入してテストしたジョイパッドの動作可否情報を[機種毎にリストアップして公開（ドキュメント対処）](https://github.com/suzukiplan/vgszero/?tab=readme-ov-file#supported-usb-joypad)をしておきましたが、もっとシステム的＆確実なアプローチでの解決策も欲しいところです。

そこで __USB に頼らない確実に動作可能なジョイパッド__ への対応を検討することにしました。

# ジョイパッド概論

まず、「そもそもジョイパッドとは何なのか？」を私なりに考えてみたところ、「ボタンとインタフェースである」という解にいきついたので、ボタンとインタフェースについての概論を記します。（ガワも重要かもしれませんが）

## ボタンの電気的な仕組み

ジョイパッドで使われるボタンの電気的な仕組みはものすごく単純です。

以下、[セイミツ工業 PS-14-PCDN ネジ式パールキャップクリア押しボタン24φ](https://item.rakuten.co.jp/attasa/ps-14-pcdn/) を例に説明します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2161417/940f759c-1e54-5fd0-6f0e-55bab19201ac.png)

2本のファストン端子があり、ボタンを押すと内部的にそれらが結線され、ボタンを離すと断線されるメカニカル構造になっています。

つまり、以下のような形にすることでボタンの押下状態をプログラムで検出できます。

1. 片方のファストン端子を GPIO に接続
1. もう片方のファストン端子を GND に接続
1. プログラムで GPIO を PULLUP の入力設定にする
1. プログラムで GPIO を読み取る:
    - ボタンを離している時: `HIGH (1)`
      - _GPIO が導電状態_
    - ボタンを押している時: `LOW (0)`
      - _GPIO と GND で接続されることで絶縁状態になる_

以下のツイートは RaspberryPi Zero 2W (VGS-Zero) ではなく RaspberryPi Pico (東方VGS実機版) ですが、上記の判定によりボタンの ON/OFF を画面上部に表示しています。

https://twitter.com/suzukiplan/status/1727560991880474891

十字キーやジョイスティックも仕組み的には全く同じで、上下左右に対応する 4 つのボタンの押下状態をプログラムで検出することができます。

https://twitter.com/suzukiplan/status/1728230885663907977

MSX でジョイパッドの入力処理を実装する場合、AY-3-8910 のレジスタ 0x0E の各ビットで上下左右とトリガの押下状態を判定しますが、各ビットは入力されている状態ならリセット (0)、未入力状態ならセット (1) になります。「普通逆では？」と思った方も多いと思われますが、これは「ボタンの電気的な仕組みによるもの」と考えれば腑に落ちます。_（ですがやはり不自然なので、初めてプログラムを組んだ時に逆判定で実装してバグりがち）_

## ジョイパッドのインタフェース

ボタンの電気的な仕組みは、約半世紀前のレトロゲーム機でも最新のプレイステーション5でもほぼ同じだと思われます。アナログスティックは比較的新しい（30年ぐらい前の）ものですが。

しかし、インタフェースは多様にあります。

家庭用ゲーム機で最初に普及したインタフェースは D-SUB9 ピン（DB9）のアタリ規格だと思われますが、DB9 は同じ形状でも各ピンの用途が機種により微妙に異なります。

具体的には、上下左右、トリガ1（Aボタン）、GNDについては概ね各社ジョイパッドで共通のピンアサインになっていますが、ATARI VCS に存在しなかったトリガ2（Bボタン）については機種によりピンの割当がかなり異なり、ある機種ではトリガ2なのに別機種ではVCC（電源）というものが存在します。

これはとても危険です。

例えば、同じ DB9 ジョイパッドだからと別のゲーム機に繋いだ時、Bボタンを押したら機器が故障して動かなくなる可能性があるようです。（参考: [この Wikipedia の「歴史」の箇所](https://ja.wikipedia.org/wiki/%E3%82%A2%E3%82%BF%E3%83%AA%E4%BB%95%E6%A7%98%E3%82%B8%E3%83%A7%E3%82%A4%E3%82%B9%E3%83%86%E3%82%A3%E3%83%83%E3%82%AF)を参照）

DB9 より後の世代は色々ゴチャゴチャしていたので省略します:sweat_smile:

混乱期（ゴチャゴチャ世代）の後、ジョイパッドのインタフェースは概ね USB に統一されました。

USB の通信方式（シリアルバス通信）は、1本のピンを特定の間隔で高速に ON/OFF してデータの送受信を行います。その間隔は USB の規格により異なりますが、USB2.0 であれば最大 480Mbps (1秒間に約5億回のON/OFFで 60MB のデータを伝送）です。

1秒間に5億回もの read/write を要するということは、__USB の通信処理には物凄く多大なオーバーヘッドが掛かる__ ことは想像に難くないと思われます。

オーバーヘッドの問題は、「力こそパワー」（マシンを強くすること）で解決できますが、限界まで早く伝送しても1ビットの送信に USB2.0 なら最速でも0.5ns程度の時間が掛かるので、1バイトの通信であれば4ns程度の伝送遅延が発生することは避けられません。さらに、最大速度で伝送すると消費電力やマシン負荷が大きくなるため、実際にはもっと遅い速度（1.5Mbps 程度？）で通信していると思われ、おそらく数マイクロ秒～数ミリ秒程度の入力遅延が発生するものと思われます。

そのため、USB は高度なレスポンス性能が求められるジョイパッドに最適なインタフェースとは言い難いかもしれません。もちろん、体感的（実用的）には気にならない遅延（マイクロ秒オーダー以下）に抑えられているものと思われますが、「遅延ナシ！」みたいなことを堂々と謳っているジョイパッドのインタフェースが USB や I2C などのシリアル通信だと、若干モヤっとした気持ちになってしまいます...それでも Bluetooth よりは幾分マシではありますが。_（これだからマニアは面倒くさい...）_

DB9 と USB 以外には、JAMMA 規格あたりが有名かもしれません。

完全に私見ですが JAMMA 規格が一番好きです。（シンプル＆ゲーム専用なので）

JAMMA 規格は主に業務用ゲーム機で使われていたもので、以下のサイトに掲載されているメーカー資料によると、端子番号18〜25が1Pのジョイパッドのピンアサインになっているようです。

https://www.ne.jp/asahi/cc-sakura/akkun/mame/yougo8.html

DB9 や JAMMA はボタンの電気的な信号が SoC にそのまま伝わるため、伝送遅延が発生しません。厳密にはボタンからGPIOまでの電子の移動速度や導線のノイズ等による遅延が発生すると思われるので「遅延ゼロ」とまでは言いませんが、**極めて遅延ゼロに近い** と思われます。


# VGS-Zero 独自ジョイパッドの設計

RaspberryPi Zero 2W は GPIO が露出しているので、インタフェースを介さずダイレクトに GPIO とボタンを接続することが可能です。

これにより、確実に動作することは勿論、DB9 や JAMMA と仕組み的に等価な（極めて遅延ゼロに近い）完璧なジョイパッドを実現できます。

## RaspberryPi Zero 2W のピン配置

RaspberryPi Zero 2W には 40 本のピン（を半田づけするスルーホール）があり、VGS-Zero に必要なボタンは 8 個（上下左右, A, B, Select, Start）しかないので、1ボタン = 1GPIO という形で余裕だろう...と思ってピン配置の仕様をチェックしたところ、使用できる GPIO ポート（汎用 GPIO ポート）は意外と少ないことが分かりました。

![Screenshot from 2024-02-13 11-20-08.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2161417/221927af-87fd-5389-d227-cbcd52f492d3.png)

上図の緑色で塗りつぶしている箇所が今回の用途（ジョイパッド接続）で使用できる汎用 GPIO で、G4〜G6 の 3 本 + G22〜G27 の 6 本の __9 本__ しかありません。

8本あれば足りるのでギリギリセーフ...:thinking:

## VGS-Zero ジョイパッドのピンアサイン

下表のようなピンアサインにしました。

| Button | GPIO |
|:------:|:----:|
| Up     | 22   |
| Down   | 5    |
| Left   | 26   |
| Right  | 6    |
| A      | 24   |
| B      | 25   |
| Start  | 4    |
| Select | 23   |

上記の表を先程の図面とマージすると下図のような形になります。

![Screenshot from 2024-02-13 11-32-10.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2161417/f7ac10b9-bed0-3b90-3a54-494c221ad8a1.png)

このピンアサインに対応した VGS-Zero のカーネル（バージョン 1.3.0）は既にリリース済みです。

https://twitter.com/suzukiplan/status/1756935671741350095

カーネルの対応実装は極めてシンプルで [こちらの commit](https://github.com/suzukiplan/vgszero/commit/de03ea3e9bdde978bac55a25105b23d35cc15edd) で確認できます。

GPIO の割り当てが気に入らない場合、CKernel のコンストラクタで初期化している gpioXXX の第一引数を変更すれば OK です。

```c++
CKernel::CKernel(void) : screen(480, 384),
                         timer(&interrupt),
                         logger(LogPanic, nullptr),
                         usb(&interrupt, &timer, TRUE),
                         vchiq(CMemorySystem::Get(), &interrupt),
                         sound(&vchiq, (TVCHIQSoundDestination)options.GetSoundOption()),
                         emmc(&interrupt, &timer, &led),
                         mcm(CMemorySystem::Get()),
                         gpioUp(22, GPIOModeInputPullUp),     // ココ
                         gpioDown(5, GPIOModeInputPullUp),    // ココ
                         gpioLeft(26, GPIOModeInputPullUp),   // ココ
                         gpioRight(6, GPIOModeInputPullUp),   // ココ
                         gpioA(24, GPIOModeInputPullUp),      // ココ
                         gpioB(25, GPIOModeInputPullUp),      // ココ
                         gpioStart(4, GPIOModeInputPullUp),   // ココ
                         gpioSelect(23, GPIOModeInputPullUp), // ココ
                         gamePad(nullptr)
```


上記のツイートでも言及してますが、折角 RaspberryPi を使っているので自作ジョイパッドや自作ケースなどの同人ハードがどんどん出てくると良いなと妄想しています。VGS-Zero はゲームを創る人だけでなく、同人ハードを創る人にとっても遊べる土台になれたら良いなと。

_とかいいつつ、汎用 GPIO を 8 つも潰すのは中々の暴挙かもしれませんが..._

I2C、UART、SPI などの用途が決まっている GPIO を潰すのは得策ではないので使用を避けていて、汎用 GPIO はあまり使いどころが無いので潰してしまってもヘーキヘーキ...などと思っていたりするのですが、如何せん私は電子工作についてほぼ初心者なので、色々なことに想像が及んでいない可能性は否定できません😅

MSX-BBS でそちら方面に詳しい[ちくわ帝国さん](https://twitter.com/chikuwa_empire)から、「[エンコーダIC](https://akizukidenshi.com/catalog/g/g108599/)を使えば8入力を3ビットにできるよ」とアドバイスを頂いたので、将来的に汎用 GPIO が必要になったらエンコーダ IC を導入するかもしれません。

# テスト

どこの家庭にもある余り物のアケコンスティック（三和製）とボタン（セイミツ製）と、Amazonで購入した中国製のアケコンケース（1,000円）を使って組み立てた自作アケコンがあるので、それをそのまま流用しました。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2161417/61388366-d5d1-53b3-8d22-ba21d8a3db76.png)

天板の内側は下図のような形です。

![GGHGBsRbwAA_xi5.jpg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2161417/d370d71b-acdc-b18d-544a-4300d9629959.jpeg)

写真の下の方にユニバーサル基板がありますが、これは各ボタンの GND を 1 本に集約する用途で使っています。

給電が必要な電子機器は一切無いので、RaspberryPi Zero 2W の GPIO 8 本 + GND 1 本接続にかかる消費電力（16mA x 9 = 144mA）が増加します。USB ジョイパッドを接続すると 500mA 程度の消費電力が掛かるので、GPIO ジョイパッド接続にすれば消費電力を 300mA 程度減らすことができエコロジーな筈です。（測定機器を持っていないので測定はしていませんが）

もちろん、正常に動作しました:tada:

https://twitter.com/suzukiplan/status/1756897641529848141

このアケコンで Battle Marine をプレイしてみたところ、USB ジョイパッドと比べて格段に遅延が無いことを体感できました。

Windows 版の Battle Marine（開発中）を USB ジョイパッドで動かしていますが、それと同等か、もしかすると Windows 版以上に快適かもしれません。

これについては「自分で作った料理が美味い」のと同じ一種のプラシーボ効果みたいなものかもしれませんが。Windows PC（Surface Laptop GO2を使用）ならマシンパワーが強いので、USBでもほぼ遅延が発生しない筈です。

しかし、RaspberryPi Zero 2W では高オーバーヘッドな USB 通信を処理するにはやはり力不足だったようで、明確な入力レスポンスの向上を体感できます。

かなり難度が高いと思いますが、是非とも電子工作にチャレンジして GPIO ジョイパッドの「本物のゼロ遅延」を体感して頂きたいところです。

_はんだ無しで RaspberryPi Zero 2W に取り付け可能な同人ハード作って家電のケンちゃんあたりで販売すれば結構売れるんじゃないかな？（同人ハードは専門外なのでよく分かりませんが）_