[PC-98][ESP32] USBマウス・キーボードをESP32でPC-98につなげる②

いやぁ1月～3月までずっとスキーしてました。パソコンやマイコンなんてほっておいてました。カービングは奥が深いよ！みんな冬は外へ出ましょう！ほっときすぎたせいで、Mac Mini起動してないのに壊れるとか…どゆこと？。では、完全に忘れていた98とUSBマウス・キーボードの続きですw。

ANDROIPHONE

2023.12.22

[PC-98][ESP32] USBマウス・キーボードをESP32でPC-98につなげる①

https://androiphone.uvs.jp/?p=4136

過去、PS/2マウス、キーボードをArduino Nanoを介して98に接続してきました。プロトタイプ機まで作り問題なく動作しています。今回は、最終の目標であるUSBキーボード、マウスを98に接続したものです。一応目標として EPS32を一つでマウス・キーボードを変換 USBワイヤレスキーボード、USBワイヤレスマウスをつないでワイヤレス化セットアップメニュー起動、24/31KHz起動など98特有の起動に対応 CAPS、カナ、NumLkのLEDの実装です。マイコンの準備今回利用するマイコンはNanoではなくESP32を使います。PSRAMとか不要なのでスタン...

前までにUSB Host ShieldのセットアップとUSB HostLibrary 2.0のセットアップ・サンプルコードの動作まで終了しました。

ESP32開発ボードは、アンテナと周波数バランス、パワーアンプ、ローノイズアンプ、フィルタ、パワーマネージメントモジュールを統合しています ESP32開発ボードは、2.4GHzデュアルモールドWi-FiおよびBLEチップと共に使用されます。40nmのローパワーテクノロジーを採用しています。電源特性、電波特性が良く、様々なアプリケーションに拡張可能です強力、LWIPプロトコル、freeRTOSをサポートします AP、STA、AP+STAをサポートします ESP32開発ボードは、luaスクリプトに...

DiyStudio 3個セット ESP32開発ボード NodeMCUモジュール 2.4 GHz デュアルコア Wi-Fi + BLE CP2102 チップ

(7)

￥2,699 (2024年4月30日 14:32 GMT +09:00 時点 – 詳細はこちら価格および発送可能時期は表示された日付/時刻の時点のものであり、変更される場合があります。本商品の購入においては、購入の時点で当該の Amazon サイトに表示されている価格および発送可能時期の情報が適用されます。)

カスタムレポートパーサー作成の準備

USBHIDBootKbdAndMouse.inoをベースにして改造していきます。キーボード、マウスのデータの処理は用意されたレポートパーサーというクラスで行っています。

キーボードはKeyboardReportParserというクラスを継承して作ったサブクラスにカスタムの処理を拡張して利用します。以前利用したライブラリにあったサンプルでは押されたキーをASCIIで表示したりシフトなどのキーの押す離すを表示したりする簡易なものとなっています。以下の部分です。

class KbdRptParser : public KeyboardReportParser
{
    void PrintKey(uint8_t mod, uint8_t key);

  protected:
    void OnControlKeysChanged(uint8_t before, uint8_t after);
    void OnKeyDown	(uint8_t mod, uint8_t key);
    void OnKeyUp	(uint8_t mod, uint8_t key);
    void OnKeyPressed(uint8_t key);
};

void KbdRptParser::PrintKey(uint8_t m, uint8_t key)
{
  MODIFIERKEYS mod;
  *((uint8_t*)&mod) = m;
  Serial.print((mod.bmLeftCtrl   == 1) ? "C" : " ");
  Serial.print((mod.bmLeftShift  == 1) ? "S" : " ");
  Serial.print((mod.bmLeftAlt    == 1) ? "A" : " ");
  Serial.print((mod.bmLeftGUI    == 1) ? "G" : " ");

  Serial.print(" >");
  PrintHex<uint8_t>(key, 0x80);
  Serial.print("< ");

  Serial.print((mod.bmRightCtrl   == 1) ? "C" : " ");
  Serial.print((mod.bmRightShift  == 1) ? "S" : " ");
  Serial.print((mod.bmRightAlt    == 1) ? "A" : " ");
  Serial.println((mod.bmRightGUI    == 1) ? "G" : " ");
};

void KbdRptParser::OnKeyDown(uint8_t mod, uint8_t key)
{
  Serial.print("DN ");
  PrintKey(mod, key);
  uint8_t c = OemToAscii(mod, key);

  if (c)
    OnKeyPressed(c);
}

void KbdRptParser::OnControlKeysChanged(uint8_t before, uint8_t after) {

  MODIFIERKEYS beforeMod;
  *((uint8_t*)&beforeMod) = before;

  MODIFIERKEYS afterMod;
  *((uint8_t*)&afterMod) = after;

  if (beforeMod.bmLeftCtrl != afterMod.bmLeftCtrl) {
    Serial.println("LeftCtrl changed");
  }
  if (beforeMod.bmLeftShift != afterMod.bmLeftShift) {
    Serial.println("LeftShift changed");
  }
  if (beforeMod.bmLeftAlt != afterMod.bmLeftAlt) {
    Serial.println("LeftAlt changed");
  }
  if (beforeMod.bmLeftGUI != afterMod.bmLeftGUI) {
    Serial.println("LeftGUI changed");
  }

  if (beforeMod.bmRightCtrl != afterMod.bmRightCtrl) {
    Serial.println("RightCtrl changed");
  }
  if (beforeMod.bmRightShift != afterMod.bmRightShift) {
    Serial.println("RightShift changed");
  }
  if (beforeMod.bmRightAlt != afterMod.bmRightAlt) {
    Serial.println("RightAlt changed");
  }
  if (beforeMod.bmRightGUI != afterMod.bmRightGUI) {
    Serial.println("RightGUI changed");
  }

}

void KbdRptParser::OnKeyUp(uint8_t mod, uint8_t key)
{
  Serial.print("UP ");
  PrintKey(mod, key);
}

void KbdRptParser::OnKeyPressed(uint8_t key)
{
  Serial.print("ASCII: ");
  Serial.println((char)key);
};

class KbdRptParser : public KeyboardReportParser

{

void PrintKey(uint8_t mod, uint8_t key);

protected:

void OnControlKeysChanged(uint8_t before, uint8_t after);

void OnKeyDown (uint8_t mod, uint8_t key);

void OnKeyUp (uint8_t mod, uint8_t key);

void OnKeyPressed(uint8_t key);

};

void KbdRptParser::PrintKey(uint8_t m, uint8_t key)

{

MODIFIERKEYS mod;

*((uint8_t*)&mod) = m;

Serial.print((mod.bmLeftCtrl == 1) ? "C" : " ");

Serial.print((mod.bmLeftShift == 1) ? "S" : " ");

Serial.print((mod.bmLeftAlt == 1) ? "A" : " ");

Serial.print((mod.bmLeftGUI == 1) ? "G" : " ");

Serial.print(" >");

PrintHex<uint8_t>(key, 0x80);

Serial.print("< ");

Serial.print((mod.bmRightCtrl == 1) ? "C" : " ");

Serial.print((mod.bmRightShift == 1) ? "S" : " ");

Serial.print((mod.bmRightAlt == 1) ? "A" : " ");

Serial.println((mod.bmRightGUI == 1) ? "G" : " ");

};

void KbdRptParser::OnKeyDown(uint8_t mod, uint8_t key)

{

Serial.print("DN ");

PrintKey(mod, key);

uint8_t c = OemToAscii(mod, key);

if (c)

OnKeyPressed(c);

}

void KbdRptParser::OnControlKeysChanged(uint8_t before, uint8_t after) {

MODIFIERKEYS beforeMod;

*((uint8_t*)&beforeMod) = before;

MODIFIERKEYS afterMod;

*((uint8_t*)&afterMod) = after;

if (beforeMod.bmLeftCtrl != afterMod.bmLeftCtrl) {

Serial.println("LeftCtrl changed");

}

if (beforeMod.bmLeftShift != afterMod.bmLeftShift) {

Serial.println("LeftShift changed");

}

if (beforeMod.bmLeftAlt != afterMod.bmLeftAlt) {

Serial.println("LeftAlt changed");

}

if (beforeMod.bmLeftGUI != afterMod.bmLeftGUI) {

Serial.println("LeftGUI changed");

}

if (beforeMod.bmRightCtrl != afterMod.bmRightCtrl) {

Serial.println("RightCtrl changed");

}

if (beforeMod.bmRightShift != afterMod.bmRightShift) {

Serial.println("RightShift changed");

}

if (beforeMod.bmRightAlt != afterMod.bmRightAlt) {

Serial.println("RightAlt changed");

}

if (beforeMod.bmRightGUI != afterMod.bmRightGUI) {

Serial.println("RightGUI changed");

}

void KbdRptParser::OnKeyUp(uint8_t mod, uint8_t key)

{

Serial.print("UP ");

PrintKey(mod, key);

}

void KbdRptParser::OnKeyPressed(uint8_t key)

{

Serial.print("ASCII: ");

Serial.println((char)key);

};

マウスレポートパーサーも同様にMouseReportParserを継承して作られています。MouseReportParserでマウスイベントを発生させ継承したサブクラス(MouseRptParser)で情報の表示を行っています。宣言と実装部は以下です

class MouseRptParser : public MouseReportParser
{
  protected:
    void OnMouseMove(MOUSEINFO *mi);
    void OnLeftButtonUp(MOUSEINFO *mi);
    void OnLeftButtonDown(MOUSEINFO *mi);
    void OnRightButtonUp(MOUSEINFO *mi);
    void OnRightButtonDown(MOUSEINFO *mi);
    void OnMiddleButtonUp(MOUSEINFO *mi);
    void OnMiddleButtonDown(MOUSEINFO *mi);
};
void MouseRptParser::OnMouseMove(MOUSEINFO *mi)
{
  Serial.print("dx=");
  Serial.print(mi->dX, DEC);
  Serial.print(" dy=");
  Serial.println(mi->dY, DEC);
};
void MouseRptParser::OnLeftButtonUp	(MOUSEINFO *mi)
{
  Serial.println("L Butt Up");
};
void MouseRptParser::OnLeftButtonDown	(MOUSEINFO *mi)
{
  Serial.println("L Butt Dn");
};
void MouseRptParser::OnRightButtonUp	(MOUSEINFO *mi)
{
  Serial.println("R Butt Up");
};
void MouseRptParser::OnRightButtonDown	(MOUSEINFO *mi)
{
  Serial.println("R Butt Dn");
};
void MouseRptParser::OnMiddleButtonUp	(MOUSEINFO *mi)
{
  Serial.println("M Butt Up");
};
void MouseRptParser::OnMiddleButtonDown	(MOUSEINFO *mi)
{
  Serial.println("M Butt Dn");
};

class MouseRptParser : public MouseReportParser

{

protected:

void OnMouseMove(MOUSEINFO *mi);

void OnLeftButtonUp(MOUSEINFO *mi);

void OnLeftButtonDown(MOUSEINFO *mi);

void OnRightButtonUp(MOUSEINFO *mi);

void OnRightButtonDown(MOUSEINFO *mi);

void OnMiddleButtonUp(MOUSEINFO *mi);

void OnMiddleButtonDown(MOUSEINFO *mi);

};

void MouseRptParser::OnMouseMove(MOUSEINFO *mi)

{

Serial.print("dx=");

Serial.print(mi->dX, DEC);

Serial.print(" dy=");

Serial.println(mi->dY, DEC);

};

void MouseRptParser::OnLeftButtonUp (MOUSEINFO *mi)

{

Serial.println("L Butt Up");

};

void MouseRptParser::OnLeftButtonDown (MOUSEINFO *mi)

{

Serial.println("L Butt Dn");

};

void MouseRptParser::OnRightButtonUp (MOUSEINFO *mi)

{

Serial.println("R Butt Up");

};

void MouseRptParser::OnRightButtonDown (MOUSEINFO *mi)

{

Serial.println("R Butt Dn");

};

void MouseRptParser::OnMiddleButtonUp (MOUSEINFO *mi)

{

Serial.println("M Butt Up");

};

void MouseRptParser::OnMiddleButtonDown (MOUSEINFO *mi)

{

Serial.println("M Butt Dn");

};

この2つのサブクラスがinoにあると、とても見にくいので.hファイルに別途記述していくようにします。僕はめんどいので.cppファイルを作らずに.hファイルに実装も記述していきます。

98用キーボードレポートパーサーの作成

とりあえず全コードをGithubに上げます。

GitHub

GitHub - maru-dinagon/USBto98KbMouseBSKBW120S: バッファローのBSKBW120Sシリー...

https://github.com/maru-dinagon/USBto98KbMouseBSKBW120S

バッファローのBSKBW120SシリーズUSBマウス・キーボードセットESP32を用いて98用キーボード・バスマウスに変換 - GitHub - maru-dinagon/USBto98KbMouseBSKBW120S: バッファローのBSKBW120SシリーズUSBマウス・キーボードセットESP32を用いて98用キーボード・バスマウスに変換

ライブラリのサンプルでも使われているKeyboardReportParserクラスが使いやすく98のキー処理もこのクラスを継承して作っています。98特有の処理、不足している処理は継承して作ったサブクラス(KbdRptParser.hのKbdRptParser)に実装していきます

大まかに下の機能を追加しました。

USBキーボードから98キーボードへスキャンコード変換
98本体とキーボードのコマンドやり取り
キーリピートの処理
CAPS,NumLock,カナのLED制御
PC-98の特殊起動(セットアップメニューなど)処理

全部説明すると大変なので、コードを見ていただくとおおむねわかると思うのですがkeyconst.hでスキャンコード変換テーブル、特殊起動時のコマンド定義などを行っています。

コマンドのやり取り、LEDの制御、キーリピート処理は常時監視処理が必要なためloopにてtask()を処理することで実現しています。おおむねPS/2キーボードの変換器を作るときと変わりはないのですが、PS/2のスキャンコードとUSBのそれは違いますし、キーリピートもキーボード側ではなく変換器で実現していますのでコードが修正してあります。

ANDROIPHONE

2023.11.09

[PC-98][Arduino] PS/2キーボードをArduinoでPC-98につなげる

https://androiphone.uvs.jp/?p=4066

さて、前回はPS/2マウスを98のバスマウスに変換して利用してみました。次にPS/2キーボードを98につなげて使えるようにしてみました。使う機材は前回と同じ格安のArduino Nano(の互換機)です。ところで、最近やっとgitHub始めました(冷やし中華的な？)。いままでずっとローカルでやってましてgitは統合開発環境なんかはリポジトリの管理が標準でついているのでなんとなく使っていました。一人でやってるんでリモートリポジトリの重要性もあんま感じなく、gitHubを覚える時間があったらコードを書こうと思っていたのですが、公開するとき...

CAPS,NumLock,カナのLEDも変換器側でつけてあり制御しています。NumLockについては変換器側でテンキー部のキーコードを変換しています。LEDは抵抗(10kΩ程度)をかませて定義されているのピンで接続しています。

PC-98の特殊起動の実現

セットアップメニューなどの特殊モードでの起動は、以前PS2キーボード変換器制作時に解説した通り、起動直後でコマンドを送らないとなりません。ESP32ではUSB Host Shieldの初期化をしキーボードを認識するまでには時間がかかりすぎてUSBキーボードからは起動することができないため、変換器にボタンを設置してそれを押して起動することで実現しています。

static uint8_t BOOTMODE_SETUP_MENU[2] = {0x3F,0xBF};
static uint8_t BOOTMODE_CRT_24[4]     = {0x01,0x73,0x81,0x01};
static uint8_t BOOTMODE_CRT_31[4]     = {0x02,0x73,0x82,0x02};
static uint8_t BOOTMODE_BIOS_REV[5]   = {0x01,0x3F,0x00,0x80,0x00};
static uint8_t BOOTMODE_CPU_MSG[5]    = {0x73,0x74,0x72,0x71,0xF4};
static uint8_t BOOTMODE_NO_MEMCHK[3]  = {0x60,0xE0,0x60};

static uint8_t BOOTMODE_SETUP_MENU[2] = {0x3F,0xBF};

static uint8_t BOOTMODE_CRT_24[4] = {0x01,0x73,0x81,0x01};

static uint8_t BOOTMODE_CRT_31[4] = {0x02,0x73,0x82,0x02};

static uint8_t BOOTMODE_BIOS_REV[5] = {0x01,0x3F,0x00,0x80,0x00};

static uint8_t BOOTMODE_CPU_MSG[5] = {0x73,0x74,0x72,0x71,0xF4};

static uint8_t BOOTMODE_NO_MEMCHK[3] = {0x60,0xE0,0x60};

上の定義はkeyconst.hの抜粋ですが6つの起動モードを定義してあります。右辺値が起動時に必要なコマンドとなります。6つのボタンを変換機に組み込みますが、ピン数節約のためボタンアレイ(分圧回路)を接続し1pinのみで制御しています。ESP32販売元のEspressifの以下の資料を参考にしています。

dl.espressif.com

https://dl.espressif.com/dl/schematics/ESP32-LyraTD-MSC_B_V1_1-1109A.pdf

(抜粋)

98用マウスレポートパーサーの作成

マウスレポートパーサーはスクロール機能やボタンを多く持つマウス、複合デバイスでの特殊なマウスなど色々なパターンがあり、ライブラリ標準のMouseReportParserだと、機能不足な面もありましたので、色々なHIDデバイスのレポートパーサーの継承元であるHIDReportParserを継承して98用に作ってみました。

Pc98MouseReportParserがそれにあたります。マウス毎にデータ処理が必要になってくるので実際にはPc98MouseReportParserを継承したサブクラス(サンプルではBskBw120aMParserに当たります)を作り、それを使っていきます。

話は少しそれますが、別な特殊マウスを使いたいなど、Pc98MouseReportParserを継承して実際にサブクラスを作る場合、実際のデータを目で確かめなければならないと思います。その場合はPc98MouseReportParserの22行目付近のOUTPUT_MOUSE_DATA=trueにすれば、シリアルにデータが表示されますので、それをもとにデータを解析します。

また、ホイール部のスクロール情報など特殊な情報をデータとして受け取りたい場合はパーサーがセットされるデバイスのHIDBootでREPORTER PROTOCOLを有効にする必要があります。

Qiita

Arduinoでキー変換器を作る(BLE編)：スクロール対応 - Qiita

https://qiita.com/sushisushiBoo/items/d93d0814ed0dacf7a7e8

https://qiita.com/sushisushiBoo/items/3b0be1c026cad10306f4こちらでBLE対応したキー変換器を作ったが、USB接続するキーボードはThin…

サンプルではUSBto98KbMouseBSKBW120S.inoの

～　略　～

USB         Usb;
USBHub     Hub(&Usb);

HIDBoot < USB_HID_PROTOCOL_KEYBOARD | USB_HID_PROTOCOL_MOUSE > HidComposite(&Usb,false);

KbdRptParser KbdPrs;
BskBw120aMParser MousePrs;

～　略　～

～　略　～

USB Usb;

USBHub Hub(&Usb);

HIDBoot < USB_HID_PROTOCOL_KEYBOARD | USB_HID_PROTOCOL_MOUSE > HidComposite(&Usb,false);

KbdRptParser KbdPrs;

BskBw120aMParser MousePrs;

～　略　～

HidComposite(&Usb,false);をHidComposite(&Usb,true);にしてあげればいいのですが、このサンプルでtrueに変えると受け取るデータの構造が変わりますのBskBw120aMParserでは処理できませんのでマウスは当然動かなくなります。OUTPUT_MOUSE_DATA=trueにすれば生データを見れますので、スクロール情報も見てみたい方はどうぞ…。

話を戻します。Pc98MouseReportParserは

USBマウスデータから98マウスデータへの変換・送信

これのみを担当しています。スクロールアップ、ダウンなどの定義の作りこみがまだ甘い(実装できるかな？)ですが、カーソルやボタンの押し離しは問題なくできます。

ライブラリ標準のMouseReportParserではデータをMOUSEINFO構造体にキャストして使っていますが、このクラスのMOUSEINFO_EX構造体は、あくまで箱として利用してParseMouseDataのオーバーロード関数で参照渡しされた引数MOUSEINFO_EX &pmiにセットしていく形としています。

そのうち他のマウスのサンプルも少し上げていきたいと思います。

その他の説明

inoファイルは基本的にloop()でUsb.Task();を処理します。KbdPrs.Task();は98側とキーボードデータのやり取りを常時行っています。最初はloop()で両方の処理を実施していたのですが、Usb.Task()が重い処理(特に初期化時)で回らなくなってキーボードのデータ処理が追い付いていないことが判明しました。というわけでESP32のデュアルコアを生かし、Core0(通常Wifiで利用)にてキーボードデータ処理をマルチタスクで実装しています。

void loop()
{
  Usb.Task();
  //KbdPrs.task();
}

void Core0_KbdTask(void *args) {
  while (1) {
    delay(1);
    KbdPrs.task();
  }
}

void loop()

{

Usb.Task();

//KbdPrs.task();

}

void Core0_KbdTask(void *args) {

while (1) {

delay(1);

KbdPrs.task();

}

ESP32との接続

ピンアサインはコード中に書いていますが

//98側キーボード(miniDin8)ピン定義
#define RST 4 //リセット要求
#define RDY 34 //送信可能
#define RXD 22                                                                                                                                                                                                            //データ送信
#define RTY 39 //再送要求

//ボタンアレイ接続ピン定義
#define BUTTON_ARRAY_ADC_PIN 35

//LED接続ピン定義
#define KANA_LED 12
#define CAPS_LED 13
#define NUM_LED  15

//98側マウス(miniDin9)ピン定義
#define XA 27
#define XB 14
#define YA 32
#define YB 33
#define LB 25
#define RB 26

//98側キーボード(miniDin8)ピン定義

#define RST 4 //リセット要求

#define RDY 34 //送信可能

#define RXD 22 //データ送信

#define RTY 39 //再送要求

//ボタンアレイ接続ピン定義

#define BUTTON_ARRAY_ADC_PIN 35

//LED接続ピン定義

#define KANA_LED 12

#define CAPS_LED 13

#define NUM_LED 15

//98側マウス(miniDin9)ピン定義

#define XA 27

#define XB 14

#define YA 32

#define YB 33

#define LB 25

#define RB 26

となっています。MiniDin側(98と接続する側、RST,RDY,RXD,RTY,XA,XB,YA,YB,LB,RB)はロジック電圧が5vですので、ロジック変換機をかませて3.3vにしてESP32と接続してください。直結すると破損しますよ？コネクタのピンアサインはPS/2変換器の時の記事を参考にしてください。