🌵 🤟🏾 👵🏻 ツーインワン：USBホストと複合USBデバイス ♑️ 🕉️ 👩🏽‍🎤

少し前、記事「Pastilda-オープンハードウェアパスワードマネージャー」が公開されました。このプロジェクトは公開されているので、設計プロセス、直面しているタスク、直面している困難について小さなメモを書くと面白いと判断しました。

Pastildaの主な本質は、キーボードとPCの間の一種のアダプターであることです。したがって、彼女は次のことができるはずです。

接続するキーボードのUSBホストになる、
実際のキーボードからメッセージをリダイレクトするためのPCのキーボード、またはキーボードそのもの
ディスクドライブであるため、パスワードデータベースを人間に優しい形式で編集できます。

この機能はプロジェクトの骨子であるため、最初のメモは彼に捧げられます。

USBホストの実装

そのため、まず、USBデバイスに接続されたキーボードを認識して通信できるように、USBデバイスにホストを実装する必要がありました。私の仕事ではEclipse + GNU ARM Eclipse + libopencm3バンドルを使用しているため、既製でできればlibopencm3ライブラリを使用して作成されたものを探していました。私の検索は成功すると信じない最後の瞬間まで、私の欲求は非常に太っていました。しかし、営業日の終わりに、インターネットを下にスクロールして、私は突然これに出会いました。 libusbhost？ほんと？また、libopencm3 usbに基づいて記述されたホストだけでなく、プロジェクトで使用することにしたSTM32F4の下でも記述されました。一般に、星は収束し、私の喜びは際限がありませんでした。ところで、このプロジェクトはlibopencm3の一部として作成されたことが判明しましたが、ライブラリには決して追加されませんでした。

ライブラリとして、私はlibusbhostをコンパイルしませんでした。必要なソースを取得し、キーボード用のドライバーを作成し、一般的にはすべてを駆動しました。しかし、まず最初に。

libusbhostから次のファイルを取得しました。

usbh_device_driver.h
usbh_config.h
usbh_hubbed。[ch]
usbh_lld_stm32f4。[ch]

また、usart_helpers。[Ch]ファイルがあり、その助けを借りて、デバイスからホストに送られるすべてのメッセージと多くの異なるデバッグ情報をUARTを介して端末に送信することができました。この機能を試しましたが、プロジェクトから削除しました。

usbh_driver_hid_mouse。[Ch]と同様に、キーボード用のドライバーを作成しました（usbh_driver_hid_kbd。[Ch]）。

次に、単純なクラスが実装され、ホストで動作します。

USBホストクラス

constexpr uint8_t USB_HOST_TIMER_NUMBER = 6; constexpr uint16_t USB_HOST_TIMER_PRESCALER = (8400 - 1); constexpr uint16_t USB_HOST_TIMER_PERIOD = (65535); typedef void (*redirect)(uint8_t *data, uint8_t len); typedef void (*control_interception)(); static redirect redirect_callback; static control_interception control_interception_callback; class USB_host { public: USB_host(redirect redirect_callback, control_interception control_interception_callback); void poll(); static void kbd_in_message_handler(uint8_t data_len, const uint8_t *data); static constexpr hid_kbd_config_t kbd_config = { &kbd_in_message_handler }; static constexpr usbh_dev_driver_t *device_drivers[] = { (usbh_dev_driver_t *)&usbh_hid_kbd_driver }; private: TIMER_ext *_timer; void timer_setup(); uint32_t get_time_us(); void oth_hs_setup(); };

ここではすべてが透明です。デバイスはキーボードをリッスンし、一連の特別なキーの組み合わせがログインおよびパスワード選択モードに入るのを待つ必要があります。これは、キーボード割り込みハンドラーkbd_in_message_handler（uint8_t data_len、const uint8_t * data）で発生します。イベントの開発には2つのオプションがあります。

組み合わせがない場合は、キーボードからさらにメッセージをPCにスキップする必要があります。このイベントを処理するために、_redirect_callback関数がコンストラクターに渡されました。
組み合わせが押された場合、ログインおよびパスワード選択モードに切り替えたことをシステムに通知する必要があります。したがって、キーボードからPCにメッセージをブロードキャストしなくなりました。これで、デバイス自体がキーボードになり、実際のキーボードからのメッセージがデバイスへのコマンドとして解釈されるようになりました。このようなイベントを処理するために、_control_interception_callback関数がコンストラクターに渡されました。

複合USBデバイスの実装

次に、デバイスマネージャーにデバイスをキーボードとディスクドライブの両方として表示する必要がありました。ここで、記述子のすべての魔法=）このドキュメントの第9章で、USBデバイスフレームワークについて詳しく説明します。この章は非常に注意深く読んで、それに応じてデバイス記述子を説明する必要があります。私の場合、次のことが起こりました。

複合USB記述子

 static constexpr uint8_t keyboard_report_descriptor[] = { 0x05, 0x01, 0x09, 0x06, 0xA1, 0x01, 0x05, 0x07, 0x19, 0xE0, 0x29, 0xE7, 0x15, 0x00, 0x25, 0x01, 0x75, 0x01, 0x95, 0x08, 0x81, 0x02, 0x95, 0x01, 0x75, 0x08, 0x81, 0x01, 0x95, 0x03, 0x75, 0x01, 0x05, 0x08, 0x19, 0x01, 0x29, 0x03, 0x91, 0x02, 0x95, 0x05, 0x75, 0x01, 0x91, 0x01, 0x95, 0x06, 0x75, 0x08, 0x15, 0x00, 0x26, 0xFF, 0x00, 0x05, 0x07, 0x19, 0x00, 0x2A, 0xFF, 0x00, 0x81, 0x00, 0xC0 }; static constexpr char usb_strings[][30] = { "Third Pin", "Composite Device", "Pastilda" }; static constexpr struct usb_device_descriptor dev = { USB_DT_DEVICE_SIZE, //bLength USB_DT_DEVICE, //bDescriptorType 0x0110, //bcdUSB 0x0, //bDeviceClass 0x00, //bDeviceSubClass 0x00, //bDeviceProtocol 64, //bMaxPacketSize0 0x0483, //idVendor 0x5741, //idProduct 0x0200, //bcdDevice 1, //iManufacturer 2, //iProduct 3, //iSerialNumber 1 //bNumConfigurations }; typedef struct __attribute__((packed)) { struct usb_hid_descriptor hid_descriptor; struct { uint8_t bReportDescriptorType; uint16_t wDescriptorLength; } __attribute__((packed)) hid_report; } type_hid_function; static constexpr type_hid_function keyboard_hid_function = { { 9, //bLength USB_DT_HID, //bDescriptorType 0x0111, //bcdHID 0, //bCountryCode 1 //bNumDescriptors }, { USB_DT_REPORT, sizeof(keyboard_report_descriptor) } }; static constexpr struct usb_endpoint_descriptor hid_endpoint = { USB_DT_ENDPOINT_SIZE, //bLength USB_DT_ENDPOINT, //bDescriptorType Endpoint::E_KEYBOARD, //bEndpointAddress USB_ENDPOINT_ATTR_INTERRUPT, //bmAttributes 64, //wMaxPacketSize 0x20 //bInterval }; static constexpr struct usb_endpoint_descriptor msc_endpoint[] = { { USB_DT_ENDPOINT_SIZE, //bLength USB_DT_ENDPOINT, //bDescriptorType Endpoint::E_MASS_STORAGE_IN, //bEndpointAddress USB_ENDPOINT_ATTR_BULK, //bmAttributes 64, //wMaxPacketSize 0 //bInterval }, { USB_DT_ENDPOINT_SIZE, //bLength USB_DT_ENDPOINT, //bDescriptorType Endpoint::E_MASS_STORAGE_OUT, //bEndpointAddress USB_ENDPOINT_ATTR_BULK, //bmAttributes 64, //wMaxPacketSize 0 //bInterval } }; static constexpr struct usb_interface_descriptor iface[] = { { USB_DT_INTERFACE_SIZE, //bLength USB_DT_INTERFACE, //bDescriptorType Interface::I_KEYBOARD, //bInterfaceNumber 0, //bAlternateSetting 1, //bNumEndpoints USB_CLASS_HID, //bInterfaceClass 1, //bInterfaceSubClass 1, //bInterfaceProtocol 0, //iInterface &hid_endpoint, &keyboard_hid_function, sizeof(keyboard_hid_function) }, { USB_DT_INTERFACE_SIZE, //bLength USB_DT_INTERFACE, //bDescriptorType Interface::I_MASS_STORAGE, //bInterfaceNumber 0, //bAlternateSetting 2, //bNumEndpoints USB_CLASS_MSC, //bInterfaceClass USB_MSC_SUBCLASS_SCSI, //bInterfaceSubClass USB_MSC_PROTOCOL_BBB, //bInterfaceProtocol 0x00, //iInterface msc_endpoint, 0, 0 }, }; static constexpr struct usb_config_descriptor::usb_interface ifaces[] { { (uint8_t *)0, //cur_altsetting 1, //num_altsetting (usb_iface_assoc_descriptor*)0, //iface_assoc &iface[Interface::I_KEYBOARD] //altsetting }, { (uint8_t *)0, //cur_altsetting 1, //num_altsetting (usb_iface_assoc_descriptor*)0, //iface_assoc &iface[Interface::I_MASS_STORAGE] //altsetting }, }; static constexpr struct usb_config_descriptor config_descr = { USB_DT_CONFIGURATION_SIZE, //bLength USB_DT_CONFIGURATION, //bDescriptorType 0, //wTotalLength 2, //bNumInterfaces 1, //bConfigurationValue 0, //iConfiguration 0x80, //bmAttributes 0x50, //bMaxPower ifaces };

keyboard_report_descriptorは、ヒューマンインターフェイスデバイス（HID）のデバイスクラス定義、付録E.6レポート記述子（キーボード）から取得されました。正直なところ、私はレポートの構造についてあまり理解していませんでした、私はドキュメントを信じていました）一般的に、ここに特別な注意を払う必要があるいくつかのポイントがあります：

usb_config_descriptor ： bNumInterfacesフィールドは、実際に実装されているインターフェイスと同じ数を反映する必要があります。私たちの場合、2つ：HIDとMSD
usb_interface_descriptor ： bInterfaceNumberフィールドはインターフェイスの番号を示しますが、カウントはゼロから始まるため、最初のインターフェイスの番号は0です。

それは、説明的な観点から、おそらくすべてです。記述子がライブラリーにどのように記述されているかに注意するしかありません（その記述はusbstd.hファイルにあります）。ドキュメントにはすべてが明確に記載されています。「複合デバイスをどのように説明できますか？」などの質問がなかったため、これによりタスクが大幅に簡素化されたと思われます。すべてがすぐに明らかになりました。

複合デバイスを操作するために、USB_compositeクラスを以下に記述しました。

コンポジットUSBクラス

 extern "C" void USB_OTG_IRQ(); int USB_control_callback(usbd_device *usbd_dev, struct usb_setup_data *req, uint8_t **buf, uint16_t *len, usbd_control_complete_callback *complete); void USB_set_config_callback(usbd_device *usbd_dev, uint16_t wValue); static uint8_t keyboard_protocol = 1; static uint8_t keyboard_idle = 0; static uint8_t keyboard_leds = 0; class USB_composite { public: uint8_t usbd_control_buffer[500]; UsbCompositeDescriptors *descriptors; uint8_t usb_ready = 0; usbd_device *my_usb_device; USB_composite(const uint32_t block_count, int (*read_block)(uint32_t lba, uint8_t *copy_to), int (*write_block)(uint32_t lba, const uint8_t *copy_from)); void usb_send_packet(const void *buf, int len); int hid_control_request(usbd_device *usbd_dev, struct usb_setup_data *req, uint8_t **buf, uint16_t *len, void (**complete)(usbd_device *usbd_dev, struct usb_setup_data *req)); void hid_set_config(usbd_device *usbd_dev, uint16_t wValue); };

このクラスのキーは2つの関数です。

hid_control_request関数は、 パスティルダがホスト（この場合、ホストはPC）とキーボードとして通信するために必要です。クラス外では、この関数はUSB_control_callbackを介して呼び出されます。
hid_set_config関数は、エンドポイントを構成し、前の段落で説明したUSB_control_callbackを登録するために必要です。クラス外では、この関数はUSB_set_config_callbackを介して呼び出されます。

以下は、実装のオプションです。

コールバック

 int USB_composite::hid_control_request(usbd_device *usbd_dev, struct usb_setup_data *req, uint8_t **buf, uint16_t *len, void (**complete)(usbd_device *usbd_dev, struct usb_setup_data *req)) { (void)complete; (void)usbd_dev; if ((req->bmRequestType & USB_REQ_TYPE_DIRECTION) == USB_REQ_TYPE_IN) { if ((req->bmRequestType & USB_REQ_TYPE_TYPE) == USB_REQ_TYPE_STANDARD) { if (req->bRequest == USB_REQ_GET_DESCRIPTOR) { if (req->wValue == 0x2200) { *buf = (uint8_t *)descriptors->keyboard_report_descriptor; *len = sizeof(descriptors->keyboard_report_descriptor); return (USBD_REQ_HANDLED); } else if (req->wValue == 0x2100) { *buf = (uint8_t *)&descriptors->keyboard_hid_function; *len = sizeof(descriptors->keyboard_hid_function); return (USBD_REQ_HANDLED); } return (USBD_REQ_NOTSUPP); } } else if ((req->bmRequestType & USB_REQ_TYPE_TYPE) == USB_REQ_TYPE_CLASS) { if (req->bRequest == HidRequest::GET_REPORT) { *buf = (uint8_t*)&boot_key_report; *len = sizeof(boot_key_report); return (USBD_REQ_HANDLED); } else if (req->bRequest == HidRequest::GET_IDLE) { *buf = &keyboard_idle; *len = sizeof(keyboard_idle); return (USBD_REQ_HANDLED); } else if (req->bRequest == HidRequest::GET_PROTOCOL) { *buf = &keyboard_protocol; *len = sizeof(keyboard_protocol); return (USBD_REQ_HANDLED); } return (USBD_REQ_NOTSUPP); } } else { if ((req->bmRequestType & USB_REQ_TYPE_TYPE) == USB_REQ_TYPE_CLASS) { if (req->bRequest == HidRequest::SET_REPORT) { if (*len == 1) { keyboard_leds = (*buf)[0]; } return (USBD_REQ_HANDLED); } else if (req->bRequest == HidRequest::SET_IDLE) { keyboard_idle = req->wValue >> 8; return (USBD_REQ_HANDLED); } else if (req->bRequest == HidRequest::SET_PROTOCOL) { keyboard_protocol = req->wValue; return (USBD_REQ_HANDLED); } } return (USBD_REQ_NOTSUPP); } return (USBD_REQ_NEXT_CALLBACK); } int USB_control_callback(usbd_device *usbd_dev, struct usb_setup_data *req, uint8_t **buf, uint16_t *len, usbd_control_complete_callback *complete) { return(usb_pointer->hid_control_request(usbd_dev, req, buf, len, complete)); } void USB_composite::hid_set_config(usbd_device *usbd_dev, uint16_t wValue) { (void)wValue; (void)usbd_dev; usbd_ep_setup(usbd_dev, Endpoint::E_KEYBOARD, USB_ENDPOINT_ATTR_INTERRUPT, 8, 0); usbd_register_control_callback(usbd_dev, USB_REQ_TYPE_INTERFACE, USB_REQ_TYPE_RECIPIENT, USB_control_callback ); } void USB_set_config_callback(usbd_device *usbd_dev, uint16_t wValue) { usb_pointer->hid_set_config(usbd_dev, wValue) ; }

通常、control_requestおよびset_config関数は、デバイスごとに明示的に記述する必要があります。ただし、このルールには例外があります：大容量記憶装置。そのため、USB_Compositeクラスのコンストラクターを扱います。

まず、USB OTG FSレッグを初期化します。

 GPIO_ext uf_p(PA11); GPIO_ext uf_m(PA12); uf_p.mode_setup(Mode::ALTERNATE_FUNCTION, PullMode::NO_PULL); uf_m.mode_setup(Mode::ALTERNATE_FUNCTION, PullMode::NO_PULL); uf_p.set_af(AF_Number::AF10); uf_m.set_af(AF_Number::AF10);

次に、複合デバイスを初期化し、上記のUSB_set_config_callbackを登録し、割り込みを有効にする必要があります。

  my_usb_device = usbd_init(&otgfs_usb_driver, &(UsbCompositeDescriptors::dev), &(UsbCompositeDescriptors::config_descr), (const char**)UsbCompositeDescriptors::usb_strings, 3, usbd_control_buffer, sizeof(usbd_control_buffer)); usbd_register_set_config_callback(my_usb_device, USB_set_config_callback); nvic_enable_irq(NVIC_OTG_FS_IRQ);

これは、デバイスマネージャーでデバイスを認識するのに十分です。

[USBコントローラー]タブ：複合デバイスとして、
「USB Mass Storage Device」と同じタブで、
「キーボードHID」などの「キーボード」タブ。

ただし、「USB Mass Storage Device」には、デバイスが正常に動作していないという警告が表示されます。問題は、他のUSBデバイスとは異なり、libopencm3ライブラリのusb_msc.cファイルに記述されているusb_msc_init関数を介して、大容量記憶装置が少し異なって初期化されることです。 MSDの場合、control_request関数とset_config関数を明示的に記述する必要はないことを前述しました。これは、usb_msc_init関数がすべてを行うためです。エンドポイントを構成し、すべてのコールバックを登録します。したがって、コンストラクタをもう1行追加する必要があります。

  usb_msc_init(my_usb_device, Endpoint::E_MASS_STORAGE_IN, 64, Endpoint::E_MASS_STORAGE_OUT, 64, "ThirdPin", "Pastilda", "0.00", block_count, read_block, write_block);

ここで、MSDを初期化するときに、メモリを操作するための最小限のAPIを渡す必要があることがわかります。

block_count：メモリセクターの数
read_block：セクターを読み取るための関数、
write_block：セクターを書き込むための関数。

Pastildaでは、外部フラッシュSST25VF064Cを使用します。 このチップのドライバはこちらにあります。 将来、このドライバーに基づいて、ファイルシステムはフラッシュに実装されます。 ほとんどの場合、私の同僚がこれについて詳細にある程度詳しく書いています。 しかし、MSDの動作をすばやくテストしたかったので、ファイルシステムの芽を書きました=）ここで叫ぶことができます。

だからここに。 USB_Compositeクラスのコンストラクターが追加されたので、プロジェクトをアセンブルし、デバイスをフラッシュして、「USBストレージデバイス」に警告のマークが付いていないことを確認し、「ディスクデバイス」タブで「ThirdPin Pastilda USBデバイス」を見つけることができます。そして、すべてが順調だと思われます。しかし、ない=）さらに問題があります：

1.ディスクにアクセスすることはできません。これを行おうとすると、すべてがハングし、死に、コンピューターが非常に悪くなります。

2.デバイスをディスクとして認識するには、2分以上かかります。

これらの問題と、健康に害を及ぼさずにそれらを解決する方法については、 USB大容量ストレージデバイスとlibopencm3で説明しています。

そして、ああ、奇跡！スポットなし=）これですべてが機能します。 USBホストと複合USBデバイスがあります。彼らの仕事を組み合わせるだけです。

ホストと複合デバイスの組み合わせ

私たちの目標：

Ctrl + Shift +〜の組み合わせが押されるまで、キーボードからPCへメッセージをブロードキャストします。
Ctrl + Shift +〜の組み合わせを押した後、Pastildaはコントロールを取得し、キーボードとしてメッセージをPCに送信します。その後、ブロードキャストモードに戻り、再び組み合わせを待ちます。

これをすべて実装するコードは、スティックのように簡単です。

App.cpp

 App *app_pointer; App::App() { app_pointer = this; clock_setup(); systick_init(); _leds_api = new LEDS_api(); _flash = new FlashMemory(); usb_host = new USB_host(redirect, control_interception); usb_composite = new USB_composite(_flash->flash_blocks(), _flash->flash_read, _flash->flash_write); } void App::process() { _leds_api->toggle(); usb_host->poll(); } void App::redirect(uint8_t *data, uint8_t len) { app_pointer->usb_composite->usb_send_packet(data, len); } void App::control_interception() { memset(app_pointer->key, 0, 8); app_pointer->key[2] = KEY_W; app_pointer->key[3] = KEY_O; app_pointer->key[4] = KEY_N; app_pointer->key[5] = KEY_D; app_pointer->key[6] = KEY_E; app_pointer->key[7] = KEY_R; app_pointer->usb_composite->usb_send_packet(app_pointer->key, 8); app_pointer->key[2] = 0; app_pointer->key[3] = 0; app_pointer->key[4] = 0; app_pointer->key[5] = 0; app_pointer->key[6] = 0; app_pointer->key[7] = 0; app_pointer->usb_composite->usb_send_packet(app_pointer->key, 8); app_pointer->key[2] = KEY_SPACEBAR; app_pointer->key[3] = KEY_W; app_pointer->key[4] = KEY_O; app_pointer->key[5] = KEY_M; app_pointer->key[6] = KEY_A; app_pointer->key[7] = KEY_N; app_pointer->usb_composite->usb_send_packet(app_pointer->key, 8); app_pointer->key[2] = 0; app_pointer->key[3] = 0; app_pointer->key[4] = 0; app_pointer->key[5] = 0; app_pointer->key[6] = 0; app_pointer->key[7] = 0; app_pointer->usb_composite->usb_send_packet(app_pointer->key, 8); }

コンストラクターで、必要なものをすべて初期化します。

点滅するLED。
フラッシュ。ディスク上のファイルを作成/削除できます。
ホスト。リダイレクト関数（組み合わせがない場合の処理）およびcontrol_interception（組み合わせが押された場合の処理）を渡します。
メモリの読み取り/書き込み機能を渡す複合デバイス。

そして、それだけです。開始され、デバイスのスケルトンが作成されました。ファイルシステムは、Ctrl + Shift +〜の組み合わせを押すことで、すぐに確定します。1行のメニューが表示され、暗号化されたパスワードデータベースがフラッシュに保存されます。

コメントや提案があれば嬉しいです。

そして、もちろん、 githubへのリンク。

UPD 06/27/2017：

Pastildaプロジェクトリポジトリはここに移動しました。最近、リリース1.0が公開されました。
プロジェクトの最新ニュースはこちらでご覧いただけます。
そしてついにプロジェクトサイトを立ち上げました！

ツーインワン：USBホストと複合USBデバイス

More articles: