2019/02/17(日)Raspberry Pi Zero WからUSBケーブル1本でWindows PCをwakeupする(後編)

2019/02/22 14:59 PC(全般)
Raspberry Pi Zero WからUSBケーブル1本でWindows PCをwakeupする(前編) - 色々日記(ざ・めも)の続き。

前回の記事で、Raspberry Pi Zero Wによる無線LAN経由のPCのwakeup(WOL)までは実現できた。

■課題
さて、これには2つ課題があった。

・USB-有線LAN変換アダプタの電力消費
 100BASEでも0.2W~1.2W。

・電源系と有線LANでRas Piからのケーブルが2本必要
 実際に繋いでみると変換ケーブルやらアダプタでかなり邪魔くさい

今は殆どのM/Bはスタンバイ時にUSBから電源供給ができるわけだし、OTGならデータも通るはずなのでUSBケーブル1本でできる構成を考えたい。

つまり、こう。
+----------+
|    PC    |
|  Windows |
+-----+----+
 USB  |
      |                  +-------------+
      +------------------+Ras Pi Zero W|
                 OTG Port|             |
                         +-------------+

■考察
考えた結果、Ras Pi Zero WがUSBの有線キーボード(マウス)と同じ振る舞いができればこれが達成できるという結論になった。

USBキーボードでPCをwakeupさせるのと同じイメージになる。

■HIDキーボード化&設定
ということで、下記参考サイト通りにRas Pi Zero WをUSB HIDキーボード化した。
Raspberry Pi Zero (W) をUSBキーボード(USBガジェット)にする - Qiita

他にもこことかが参考になる。
Raspberry Piを遠隔入力キーボードにする - とうふ荘の手記てき!

今回は文字列そのものを送信したいわけではないので、hardpass-sendHIDは不要。

で、wakeupさせたいので、bmAttributesをいじる必要がある。
$ sudo echo 0xa0 > /sys/kernel/config/usb_gadget/isticktoit/configs/c.1/bmAttributes
とする(初期値は0x80)。

[参考]
コンフィグレーションディスクリプタ - おなかすいたWiki!

USBからのwakeupはWOLのときと同様で、Windowsがサスペンドに入る際にそのポートからのwakeupを受け付ける状態にする必要がある模様。

・bmAttributesでbit 5が立っている
・Windowsのデバイスマネージャで「このデバイスでコンピュータのスタンバイ状態を解除できるようにする」にチェック

が必要条件。

また、当たり前だがこの構成だとサスペンド時にRaspberry Pi Zero Wに電源が供給されている必要がある。電源の設定で「USBセレクティブサスペンド」はOFFにしておく必要がありそう。

■ソース読んでパッチ当て
しかし、これだけではスタンバイ時にキーを送ってもホストPCはwakeupしなかった。

ここ、根本的に勘違いしていたのだが、そもそもUSBの場合はホスト側がデバイス側にキー情報を取りに来る。

当然サスペンド中には取りに来ないので、キーをバッファに貯めるだけではだめ。
wakeupさせる場合、USBの規格にあるwakeup用の信号パターンを送る必要がある。

昔BIOSとかで特定キーによるwakeup設定が存在していてそれが頭の中にあったのだが、PS/2限定だったのかも。追求していない。

[参考]
デカスギ電源ボタン - PukiWiki
↑Arduinoでやりたいことを実現できている!
USB Made Simple - Part 3
USB1.1仕様書

USBキーボードの実装では、USBポートの信号状態をチェック→ホストがサスペンドの場合はwakeup特殊信号を送る、と理解した。

もちろんGPIOとかを介せばやれることはわかるのだが、標準のUSBポートでやりたい。
だが、ガジェットHIDからwakeupを呼ぶ機能が見つからない。

しょうがないのでソースを読むところから。

Raspberry Piでカーネルをカスタムして構築 - karaage. [からあげ]
Kernel building - Raspberry Pi Documentation

を参考に、カーネルソースを取得する。

まずはgit, bc入れるところから。
$ sudo apt-get install git bc
ディレクトリ作って
$ cd ~
$ mkdir kernel
$ cd kernel
カーネル落とした。
この時点では、60feca6ea3fabfe870a731a48c254c6ca1593e0d(rpi-4.14.yブランチ)。
$ git clone --depth=1 https://github.com/raspberrypi/linux
最初に、config作ってやる。Pi Zero Wなので、bcmrpi_defconfigの方。
cd linux
KERNEL=kernel
make bcmrpi_defconfig

で、ソースはココらへんを読めば良いらしい。
$ lsmod
~~
udc_core               38945  3 dwc2,libcomposite,usb_f_hid
~~
ソースを読むと、hidg0に値を書き込んだときの動きは、HIDドライバ->gadget共通ドライバ->dwc2(DesignWaveのUSB2かな)ドライバだと思う。

結論から言うと、
・HIDドライバに実装がないし送る方法もなさそう
・gadget共通ドライバにはI/Fがある
・dwc2のガジェット部に実装がない

今回はキーを送る必要はなくwakeup専用デバイスにしたいので、WRITEする箇所で必ずwakeupを送る動きに変えてしまうことにする。

パッチを当てる。
当てる必要があるのは2ファイル。

HIDドライバのWRITE時に、gadgetドライバのAPIを呼び出す
--- ~/kernel/linux/drivers/usb/gadget/function/f_hid.c.orig        2019-02-17 13:21:42.845143807 +0000
+++ ~/kernel/linux/drivers/usb/gadget/function/f_hid.c     2019-02-17 13:26:25.554009039 +0000
@@ -339,10 +339,14 @@
                            size_t count, loff_t *offp)
 {
        struct f_hidg *hidg  = file->private_data;
+       struct usb_composite_dev *cdev = hidg->func.config->cdev;
        struct usb_request *req;
        unsigned long flags;
        ssize_t status = -ENOMEM;

+       usb_gadget_wakeup(cdev->gadget);
+       pr_info("Wakeup!\n");
+
        if (!access_ok(VERIFY_READ, buffer, count))
                return -EFAULT;

dwc2ドライバのガジェット部にwakeup用の関数を追加してポインタにセット。
実装はLinux本家のdwc2_gadget_exit_hibernation()を参考にした。
https://github.com/torvalds/linux/blob/master/drivers/usb/dwc2/gadget.c
--- /home/pi/kernel/linux/drivers/usb/dwc2/gadget.c.orig        2019-02-09 06:00:07.027365942 +0000
+++ /home/pi/kernel/linux/drivers/usb/dwc2/gadget.c     2019-02-17 13:37:07.611431738 +0000
@@ -4445,6 +4445,30 @@
        return usb_phy_set_power(hsotg->uphy, mA);
 }

+static int dwc2_hsotg_wakeup(struct usb_gadget *gadget)
+{
+       u32 dctl;
+       struct dwc2_dregs_backup *dr;
+        struct dwc2_hsotg *dev;
+        unsigned long flags;
+        dev = container_of(gadget, struct dwc2_hsotg, gadget);
+       dr = &dev->dr_backup;
+
+       spin_lock_irqsave(&dev->lock, flags);
+       udelay(10);
+
+       /* Start Remote Wakeup Signaling */
+       dwc2_writel(dr->dctl | DCTL_RMTWKUPSIG, dev->regs + DCTL);
+       mdelay(12);
+       dctl = dwc2_readl(dev->regs + DCTL);
+       dctl &= ~DCTL_RMTWKUPSIG;
+       dwc2_writel(dctl, dev->regs + DCTL);
+
+       spin_unlock_irqrestore(&dev->lock, flags);
+
+       return 0;
+}
+
 static const struct usb_gadget_ops dwc2_hsotg_gadget_ops = {
        .get_frame      = dwc2_hsotg_gadget_getframe,
        .udc_start              = dwc2_hsotg_udc_start,
@@ -4452,6 +4476,7 @@
        .pullup                 = dwc2_hsotg_pullup,
        .vbus_session           = dwc2_hsotg_vbus_session,
        .vbus_draw              = dwc2_hsotg_vbus_draw,
+       .wakeup                 = dwc2_hsotg_wakeup,
 };

 /**
多少ソースが変わっても再パッチは簡単そう。

■ソースメモ
なお、usb_gadget_wakeup()の実装はdrivers/usb/gadget/udc/core.cで、usb_gadget_opsのwakeupを呼んでいる。

で呼び出し側の実体はチップごとのドライバ(Ras Pi Zero Wの場合dwc2配下のgadget.c)にあるということのようだ。

読むには、
~/kernel/linux/include/linux/usb/gadget.h
と、
~/kernel/linux/drivers/usb/dwc2/hw.h
あたりに定義がたくさんあるので参照しながら進める必要がある。

■カーネル再構築
パッチを当てたら、カーネル作り直す。
$ make -j4 zImage modules dtbs
$ sudo make modules_install
$ sudo cp arch/arm/boot/dts/*.dtb /boot/
$ sudo cp arch/arm/boot/dts/overlays/*.dtb* /boot/overlays/
$ sudo cp arch/arm/boot/dts/overlays/README /boot/overlays/
$ sudo cp arch/arm/boot/zImage /boot/$KERNEL.img
最後にリブート
$ sudo reboot

■カーネル再構築(部分コンパイルする場合)
今回、カーネルまるごと作り直したけど、Pi Zeroだと一晩かかるので部分モジュールコンパイルのほうが良かったかも。

部分コンパイルする場合は、インストールされているカーネルのバージョン調べてダウンロードした後、パッチ当てて、
$ cd ~/kernel/linux
$ make drivers/usb/gadget/function/usb_f_hid.ko
$ make drivers/usb/dwc2/dwc2.ko
でパッチ対象モジュールを作れる。
あとは手動コピーで良いはず(試してない)。

■使い方
これで、次回起動後、
$ echo -ne "\0\0\0\0\0\0\0\0" > /dev/hidg0
でwakeupがホストに行くようになる(hidg0の権限次第でsudoが必要)。

前編で作ったauthorized_keysの中のコマンドをこれに差し替えることで、同じ手順でUSB wakeupができるようになった。

キーを送る機能と共存できるかは試していないので、そこは各自研究してほしい。

なお、wakeup時に/var/log/messagesに"Wakeup!"が出力される。

気に食わない人は、f_hid.cパッチのpr_infoをコメントアウトなり好きなメッセージに変えること。
うまく動かないときは、dwc2側にもpr_infoを追加して動きを確認していくといいかもしれない。

なお、くれぐれもセキュリティにはご用心&自己責任で。

■おまけ
wakeup周りの実装がないのは多分Linuxから呼ぶIFが決まってないからだと思う。

今回、規格書見た段階ではD+ D-をちょろっと動かせばいいだけだと思ってなめてかかったのだが、dwc2ドライバの中身的にはもう一段階抽象化されていてチップのレジスタに何セットして送るの世界だった。

これだとデータシートかオシロがないと厳しい。
実装するにしても、既存ソースの識別子名から勘でトライ&エラーになってしまう。

データシートについては、個人では入手できないぽいとのこと。
Linux本家にwakeup絡みの実装が見つからなかったら取りあえず動くところまでたどり着けてなかったと思う。

何はともあれ動いてよかった。

動いちゃいるけど正しい信号の動きじゃないのでは疑惑が強いので、知見がある人がいたらツッコんでほしい。

2019/02/16(土)Raspberry Pi Zero WからUSBケーブル1本でWindows PCをwakeupする(前編)

2019/02/22 14:59 PC(全般)
■やりたいこと
無線LANを経由して、屋内の離れた場所にあるPCをスリープないし休止からwakeupする。
できれば、外出先からVPN->自宅サーバを経由してwakeupもできるようにしたい。

■前提
wakeup対象のPCはWindows10 Pro。
USB無線LANドングルでホームネットワーク(仮に192.168.1.0/24とする)に接続されている。

このPCは「有線LANにはつながっていない」(重要)。

■検討
技術的には、
1) Intel AMT
2) WoWLAN
3) USB無線LANドングルを諦める。APを設置し、APを対象PCに有線LANで接続してAPからWOL
4) Raspberry Pi Zero Wなどの無線LANを備えたシングルボードコンピューターを対象PCにつないでそこからwakeup

が候補に上がる。

1)はIntel QXXXチップセットが要件だが、自作用にはほぼ出回っていないので却下。
2)は無線認証情報をスリープ・サスペンド時にどこにおいておくかという問題があって、WoWLANはハードウェアと技術的制約が厳しいという理解(実現できるケースもあるらしいがノートPC等のAll-in-One構成の場合だけ?)。
3)は消費電力がドングルよりかなり大きくなりそう。外部からのwakeupができるかが不明。
4)は技術的には問題なさそうだし、消費電力も抑えられそう。

ということで、4)コースをやってみることにした。

■購入&用意した機器
1) Raspberry Pi Zero W @8.00GBP
2) OTG LANケーブル(MicroUSB-USB TypeA) @120円
3) MicroSDカード 4GB @自宅に転がってたものを流用
4) MicroUSB-USB TypeA変換ケーブル @400円くらい
5) USB有線LAN変換アダプタ(PLANEX USB-LAN100R) @1200円くらい
6) Cat5e LANケーブル @自宅に転がってたものを流用
7) 専用公式ケース @5.00GBP

2)を電源ポートに、4)~6)をOTGポートに接続する。
3)はRaspberry Piのメインストレージ、7)はおまけ。

本体としては他にVoCore2などが候補に上がったが、入手性・価格・工作難易度等検討して、Raspberry Pi Zero Wに決めた。

購入当時は技適取ったばかりで国内の入手性が悪かったので、Pimoroniで頼んだが今はスイッチサイエンスやKSYで簡単に買えると思う。海外だと他にはMODMYPIとか。都度、必要なオプション類と値段・送料を見比べて判断すれば良し。

ヘッドレスインストールする前提なのでminiHDMI<->HDMI変換アダプタは調達しなかった。

本記事(前編)で作成する有線LANでのwakeupには1)~6)がマスト。
最終的に、次記事のUSBガジェットとしてwakeupする方法だとセットアップ含めて1)~3)がマストで、実は4)~6)は無しでいける。

■構成
PCを移動させるときに電源ケーブルが2本生えているのは気になるため、とりあえず[A構成]を目指す。
[A構成]
+----------+
|    PC    |有線LAN
|  Windows +--------------------+
+-----+----+                    |OTG Port
 USB  |                         |(USB-有線LAN変換アダプタ)
      |                  +-------------+
      +------------------+Ras Pi Zero W|
               Power Port|             |
                         +-------------+

休止状態でのUSBへの電源供給がうまくいかなかったら[B構成]。
[B構成]
+----------+
|    PC    |有線LAN
|  Windows +--------------------+
+----------+                    |OTG Port
                                |(USB-有線LAN変換アダプタ)
                         +-------------+
           +-------------+Ras Pi Zero W|
           |   Power Port|             |
           |             +-------------+
           |
     +-----+-----+
     |AC-MicroUSB|
     +-----+-----+
           |
       +-------+
       |AC100V |
       +-------+

■セットアップ方法(ログインまで)
基本下記サイトに従ってセットアップすれば良いと思う。
ラズパイ の OS イメージを焼くときは Etcher が 便利 & UI カッコいい | 験なきものを思はずは

wpa_supplicant.confは手元のdebian環境で作成したので、そのときだけこちらを参考に。
Debian で WPA-PSK(AES) 方式で無線接続 - wpa_supplicant 編 - Qiita

ログイン時はこっち。
Raspberry Pi zero W のヘッドレスインストール(キーボードやマウスなしでRaspbianをインストールする方法)

やったことを一応まとめると、https://www.raspberrypi.org/downloads/raspbian/からLITEイメージをダウンロードして、Windows機でetcherを使用してmicroSDにイメージを書き込み。

一度アンマウント->マウントし直して、ファイルマネージャでsshファイル(空ファイル)とwpa_supplicant.confをWindowsから見えるドライブのルート直下に置いた。

この状態で、Raspiberry Pi自体を電源につないで起動。初期化を待ち、DHCPで割り当てられたIPアドレスをなんとか探してsshでログインする。

なお、実は今回USB有線LAN変換アダプタを自動認識してくれたの有線でセットアップした。有線でセットアップする場合、wps_supplicant.confは後で置いても良い。

Ras Pi Zero Wに関しては無線セットアップで問題ないと思うが、自分はRasPi初めてで最初は暗中模索だった。

無線認証が1ハードルあるので、不安な人・あとから調達がめんどくさい人は、有線LAN用意しといたほうが安心感があるかも。

DHCPはある前提なので無い人は別の情報を探してほしい。

[参考]
[メモ] Raspberry Pi ZeroをUSB COMポートデバイスとして使う - Qiita
RaspberryPi Zero Wのワイヤレスセットアップ - Qiita
raspberry pi + 無線LANアダプタでWPA接続 - Qiita
Raspberry Pi ZeroをUSBケーブル1本で遊ぶ | Japanese Raspberry Pi Users Group
[メモ] Raspberry Pi ZeroをUSBケーブル一本でインターネット接続!(キーボード・マウス・モニター必要なし) - Qiita
Raspberry Pi Zero(W)のセットアップ - Qiita

なお、解説サイトにはCOMポート認識でセットアップさせる方法がよく載っているが、自分はうまくいかなかった(win7 SP1 64bit環境)。これは後述の電源断が悪かったかもしれない。とはいえ、有線/無線LAN+sshでセットアップする方がハマりが少ないと思う。

また、RasPiをネットワークから探すのにBonjourを使う方法もよく載っているがこれも入れるのに失敗(Apple不慣れなせい?)。ネットワーク内の有効IPアドレスをリストアップするソフト(nmapでもSoftPerfect Network Scannerでも)でなんとか探せるので無理していれる必要はないと思う。

つまづいたこと。

最初、RasPiの状態把握の方法がわからずに、パーティショニングが終わらない状態で電源断をしてしまったらしく、IPアドレスは取れてるのにsshアクセスが出来ない現象が発生した。

Ras Pi Zero Wには小さいLEDが付いており、これが常時点灯になってない状態でケーブル引っこ抜きとかをしてはまずいようだ。

特に初回はパーティショニングをしているとのこと。

LITEイメージをSDカードに焼き直して、最初から手順をなぞったらsshログインできるようになった。

■セットアップ(sshログインして作業)
▼piユーザのパスワード変更
$ passwd

▼パッケージ更新
$ sudo apt-get update
$ sudo apt-get upgrade
$ sudo apt-get dist-upgrade
ここまではやったほうが良い。

もちろん、アップグレード後に
$ sudo reboot
する。

sudo rpi-updateは安定版ではない最新版が入ってしまうとのことなのでやらない。

Ras Piの無線LANドライバは古いとパワーマネジメントとぶつかるのか、しょっちゅうハングアップするという問題があるらしくセキュリティの問題以上に一定のバージョンに上げる必要がある模様。

[参考]
wlan freezes in raspberry pi 3/PiZeroW (Not 3B+) · Issue #1342 · raspberrypi/linux · GitHub

logにこういうのが出てきたときはこれ。
brcmfmac: brcmf_sdio_hostmail : Unknown mailbox data content: 0x40012
今の所安定しているが、場合によってはパワーマネジメントを切る方法も試みる。

▼dhcpcd.confの編集
ifconfigして有線がeth0、無線がwlan0で認識されていることを確認。

eth0,wlan0用の固定IPアドレス設定を追加してやる。
下記設定例は、

無線LAN: 192.168.1.0/24ネットワーク(ホームネットワーク。デフォルトゲートウェイ192.168.1.1)
有線LAN: 192.168.2.0/24ネットワーク(wakeup対象のPC(192.168.2.1)とRasPiの有線だけ)

の例。

/etc/dhcpcd.confに下記設定を追加。
interface eth0
metric 50
static ip_address=192.168.2.2/24

interface wlan0
metric 100
static ip_address=192.168.1.99/24
static routers=192.168.1.1
static domain_name_servers=8.8.4.4 8.8.8.8

▼wakeonlanを導入
$ sudo apt-get install wakeonlan

▼sshの設定
piユーザ用のssh用のキーペアを2セット作って公開鍵をauthorized_keysに書く。

片方はログイン作業用、片方はwolコマンド発行用。

/home/pi/.ssh/authorized_keys
ssh-rsa XXXXXXXXXXX work_user
command="/usr/bin/wakeonlan -i 192.168.2.255 MM:MM:MM:MM:MM:MM" ssh-rsa YYYYYYYYY wol_user
MM:MM:MM:MM:MM:MMはwakeup対象PCのNICのMACアドレス。

.ssh/authorized_keysはなければ作成。
いつもどおりパーミッションに注意(.ssh ⇒ 700, authorized_keys ⇒ 600)。

ネットワーク環境によってはfromをつけてもいいかも。

必ず、1回sshでログインできることを確認してから、/etc/sshd/sshd-configを変更して下記を追加。
PermitRootLogin no
PasswordAuthentication no
$ sudo reboot
より気にするならpiユーザ以外にしたほうがいいかも。

■wakeup方法
例えば、192.168.1.0/24のWindows機からwakeupする場合、
> ssh.exe -i pi_wol_key(wolコマンド発行用の秘密鍵) -o StrictHostKeyChecking=no pi@192.168.1.99
とかで、RasPiが有線側から192.168.2.0/24にブロードキャストして対象PCがwakeupする。

なお、Windows側でUSBセレクティブサスペンドをOFFにする、でサスペンド中の電源供給もうまく行ったため、上の[構成]は[A構成]にできた。

■消費電力
REX-BTWATCHで測定。

ちなみに購入機器を含め、USB-有線LAN変換アダプタは100BASEのものを2種類試した。
(1) UtechSmart USB 2.0-10/100 Fast Ethernet
(2) PLANEX USB-LAN100R

・ACアダプタのみ; 0.15~0.2W程度
・ACアダプタ + RasPi Zero W: 0.7~1.0W
・ACアダプタ + RasPi Zero W + (1): 2.0~2.2W
・ACアダプタ + RasPi Zero W + (2): 0.9~1.2W

ということで、各デバイスの消費電力は、
・Ras Pi Zero W: 0.5~0.8W
・UtechSmart USB 2.0-10/100 Fast Ethernet: 1.2W前後
・PLANEX USB-LAN100R: 0.2W前後
となる。

(1)はLEDありで、(2)はLEDなしなのでその差も大きい気がするがUSB-有線LAN変換アダプタは想像以上に消費電力差があるようだ。

気にする人は選んだほうが良いと思う。

■まとめ
Raspberry Pi Zero Wを使って、PCからのUSB電源で完結するwol装置を作れた。消費電力はUSB-有線LAN変換アダプタを選べばなんとか1W前後。ただ、変換アダプタやらなんやらがつながってる関係上、思ったよりケーブル周りがすっきりしなかった。

ここで一応目的は達成したがケーブルがPCと2本もつながってるのが如何にも非効率な感じである。

ケーブル1本構成を実現したRaspberry Pi Zero WからUSBケーブル1本でWindows PCをwakeupする(後編) - 色々日記(ざ・めも)に続く。
OK キャンセル 確認 その他