[FL-1930] USB HID (#751)
* [FL-1930] USB HID keyboard test * [FL-1930] HID mouse demo app * [FL-1930] BadUSB: RubberDucky script parser. BadUSB test app Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
This commit is contained in:
		| @@ -6,10 +6,13 @@ | ||||
| #include "usb_hid.h" | ||||
| #include "hid_usage_desktop.h" | ||||
| #include "hid_usage_button.h" | ||||
| #include "hid_usage_keyboard.h" | ||||
|  | ||||
| #define HID_RIN_EP      0x81 | ||||
| #define HID_RIN_SZ      0x10 | ||||
|  | ||||
| #define HID_KB_MAX_KEYS 6 | ||||
|  | ||||
| struct HidIadDescriptor { | ||||
|     struct usb_iad_descriptor           hid_iad; | ||||
|     struct usb_interface_descriptor     hid; | ||||
| @@ -22,31 +25,63 @@ struct HidConfigDescriptor { | ||||
|     struct HidIadDescriptor             iad_0; | ||||
| } __attribute__((packed)); | ||||
|  | ||||
| /* HID mouse report desscriptor. 2 axis 5 buttons */ | ||||
| enum HidReportId { | ||||
|     ReportIdKeyboard = 1, | ||||
|     ReportIdMouse = 2, | ||||
| }; | ||||
|  | ||||
| /* HID report: keyboard+mouse */ | ||||
| static const uint8_t hid_report_desc[] = { | ||||
|     HID_USAGE_PAGE(HID_PAGE_DESKTOP), | ||||
|     HID_USAGE(HID_DESKTOP_KEYBOARD), | ||||
|     HID_COLLECTION(HID_APPLICATION_COLLECTION), | ||||
|         HID_REPORT_ID(ReportIdKeyboard), | ||||
|         HID_USAGE_PAGE(HID_DESKTOP_KEYPAD), | ||||
|         HID_USAGE_MINIMUM(HID_KEYBOARD_L_CTRL), | ||||
|         HID_USAGE_MAXIMUM(HID_KEYBOARD_R_GUI), | ||||
|         HID_LOGICAL_MINIMUM(0), | ||||
|         HID_LOGICAL_MAXIMUM(1), | ||||
|         HID_REPORT_SIZE(1), | ||||
|         HID_REPORT_COUNT(8), | ||||
|         HID_INPUT(HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), | ||||
|         HID_REPORT_COUNT(1), | ||||
|         HID_REPORT_SIZE(8), | ||||
|         HID_INPUT(HID_IOF_CONSTANT | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), | ||||
|         HID_REPORT_COUNT(6), | ||||
|         HID_REPORT_SIZE(8), | ||||
|         HID_LOGICAL_MINIMUM(0), | ||||
|         HID_LOGICAL_MAXIMUM(101), | ||||
|         HID_USAGE_PAGE(HID_DESKTOP_KEYPAD), | ||||
|         HID_USAGE_MINIMUM(0), | ||||
|         HID_USAGE_MAXIMUM(101), | ||||
|         HID_INPUT(HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE), | ||||
|     HID_END_COLLECTION, | ||||
|     HID_USAGE_PAGE(HID_PAGE_DESKTOP), | ||||
|     HID_USAGE(HID_DESKTOP_MOUSE), | ||||
|     HID_COLLECTION(HID_APPLICATION_COLLECTION), | ||||
|         HID_USAGE(HID_DESKTOP_POINTER), | ||||
|         HID_COLLECTION(HID_PHYSICAL_COLLECTION), | ||||
|             HID_REPORT_ID(ReportIdMouse), | ||||
|             HID_USAGE_PAGE(HID_PAGE_BUTTON), | ||||
|             HID_USAGE_MINIMUM(1), | ||||
|             HID_USAGE_MAXIMUM(3), | ||||
|             HID_LOGICAL_MINIMUM(0), | ||||
|             HID_LOGICAL_MAXIMUM(1), | ||||
|             HID_REPORT_COUNT(3), | ||||
|             HID_REPORT_SIZE(1), | ||||
|             HID_INPUT(HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), | ||||
|             HID_REPORT_SIZE(1), | ||||
|             HID_REPORT_COUNT(5), | ||||
|             HID_INPUT(HID_IOF_CONSTANT | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), | ||||
|             HID_USAGE_PAGE(HID_PAGE_DESKTOP), | ||||
|             HID_USAGE(HID_DESKTOP_X), | ||||
|             HID_USAGE(HID_DESKTOP_Y), | ||||
|             HID_USAGE(HID_DESKTOP_WHEEL), | ||||
|             HID_LOGICAL_MINIMUM(-127), | ||||
|             HID_LOGICAL_MAXIMUM(127), | ||||
|             HID_REPORT_SIZE(8), | ||||
|             HID_REPORT_COUNT(2), | ||||
|             HID_INPUT(HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE ), | ||||
|             HID_USAGE_PAGE(HID_PAGE_BUTTON), | ||||
|             HID_USAGE_MINIMUM(1), | ||||
|             HID_USAGE_MAXIMUM(5), | ||||
|             HID_LOGICAL_MINIMUM(0), | ||||
|             HID_LOGICAL_MAXIMUM(1), | ||||
|             HID_REPORT_SIZE(1), | ||||
|             HID_REPORT_COUNT(5), | ||||
|             HID_INPUT(HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE ), | ||||
|             HID_REPORT_SIZE(1), | ||||
|             HID_REPORT_COUNT(3), | ||||
|             HID_INPUT(HID_IOF_CONSTANT), | ||||
|             HID_INPUT(HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE), | ||||
|         HID_END_COLLECTION, | ||||
|     HID_END_COLLECTION, | ||||
| }; | ||||
| @@ -122,25 +157,102 @@ static const struct HidConfigDescriptor hid_cfg_desc = { | ||||
|             .bEndpointAddress       = HID_RIN_EP, | ||||
|             .bmAttributes           = USB_EPTYPE_INTERRUPT, | ||||
|             .wMaxPacketSize         = HID_RIN_SZ, | ||||
|             .bInterval              = 50, | ||||
|             .bInterval              = 10, | ||||
|         }, | ||||
|     }, | ||||
| }; | ||||
|  | ||||
| static struct { | ||||
|     int8_t      x; | ||||
|     int8_t      y; | ||||
|     uint8_t     buttons; | ||||
| } __attribute__((packed)) hid_report_data; | ||||
| struct HidReportMouse { | ||||
|     uint8_t report_id; | ||||
|     uint8_t btn; | ||||
|     int8_t x; | ||||
|     int8_t y; | ||||
|     int8_t wheel; | ||||
| } __attribute__((packed)); | ||||
|  | ||||
| struct HidReportKB { | ||||
|     uint8_t report_id; | ||||
|     uint8_t mods; | ||||
|     uint8_t reserved; | ||||
|     uint8_t btn[HID_KB_MAX_KEYS]; | ||||
| } __attribute__((packed)); | ||||
|  | ||||
| static struct HidReport { | ||||
|     struct HidReportKB keyboard; | ||||
|     struct HidReportMouse mouse; | ||||
| } __attribute__((packed)) hid_report; | ||||
|  | ||||
| static void hid_init(usbd_device* dev, struct UsbInterface* intf); | ||||
| static void hid_deinit(usbd_device *dev); | ||||
| static void hid_on_wakeup(usbd_device *dev); | ||||
| static void hid_on_suspend(usbd_device *dev); | ||||
|  | ||||
| static bool hid_send_report(uint8_t report_id); | ||||
| static usbd_respond hid_ep_config (usbd_device *dev, uint8_t cfg); | ||||
| static usbd_respond hid_control (usbd_device *dev, usbd_ctlreq *req, usbd_rqc_callback *callback); | ||||
| static usbd_device* usb_dev; | ||||
| static osSemaphoreId_t hid_semaphore = NULL; | ||||
| static bool hid_connected = false; | ||||
|  | ||||
| bool furi_hal_hid_is_connected() { | ||||
|     return hid_connected; | ||||
| } | ||||
|  | ||||
| bool furi_hal_hid_kb_press(uint16_t button) { | ||||
|     for (uint8_t key_nb = 0; key_nb < HID_KB_MAX_KEYS; key_nb++) { | ||||
|         if (hid_report.keyboard.btn[key_nb] == 0) { | ||||
|             hid_report.keyboard.btn[key_nb] = button & 0xFF; | ||||
|             break; | ||||
|         } | ||||
|     } | ||||
|     hid_report.keyboard.mods |= (button >> 8); | ||||
|     return hid_send_report(ReportIdKeyboard); | ||||
| } | ||||
|  | ||||
| bool furi_hal_hid_kb_release(uint16_t button) { | ||||
|     for (uint8_t key_nb = 0; key_nb < HID_KB_MAX_KEYS; key_nb++) { | ||||
|         if (hid_report.keyboard.btn[key_nb] == (button & 0xFF)) { | ||||
|             hid_report.keyboard.btn[key_nb] = 0; | ||||
|             break; | ||||
|         } | ||||
|     } | ||||
|     hid_report.keyboard.mods &= ~(button >> 8); | ||||
|     return hid_send_report(ReportIdKeyboard); | ||||
| } | ||||
|  | ||||
| bool furi_hal_hid_kb_release_all() { | ||||
|     for (uint8_t key_nb = 0; key_nb < HID_KB_MAX_KEYS; key_nb++) { | ||||
|         hid_report.keyboard.btn[key_nb] = 0; | ||||
|     } | ||||
|     hid_report.keyboard.mods = 0; | ||||
|     return hid_send_report(ReportIdKeyboard); | ||||
| } | ||||
|  | ||||
| bool furi_hal_hid_mouse_move(int8_t dx, int8_t dy) { | ||||
|     hid_report.mouse.x = dx; | ||||
|     hid_report.mouse.y = dy; | ||||
|     bool state = hid_send_report(ReportIdMouse); | ||||
|     hid_report.mouse.x = 0; | ||||
|     hid_report.mouse.y = 0; | ||||
|     return state; | ||||
| } | ||||
|  | ||||
| bool furi_hal_hid_mouse_press(uint8_t button) { | ||||
|     hid_report.mouse.btn |= button; | ||||
|     return hid_send_report(ReportIdMouse); | ||||
| } | ||||
|  | ||||
| bool furi_hal_hid_mouse_release(uint8_t button) { | ||||
|     hid_report.mouse.btn &= ~button; | ||||
|     return hid_send_report(ReportIdMouse); | ||||
| } | ||||
|  | ||||
| bool furi_hal_hid_mouse_scroll(int8_t delta) { | ||||
|     hid_report.mouse.wheel = delta; | ||||
|     bool state = hid_send_report(ReportIdMouse); | ||||
|     hid_report.mouse.wheel = 0; | ||||
|     return state; | ||||
| } | ||||
|  | ||||
| struct UsbInterface usb_hid = { | ||||
|     .init = hid_init, | ||||
| @@ -158,7 +270,11 @@ struct UsbInterface usb_hid = { | ||||
| }; | ||||
|  | ||||
| static void hid_init(usbd_device* dev, struct UsbInterface* intf) { | ||||
|     if (hid_semaphore == NULL) | ||||
|         hid_semaphore = osSemaphoreNew(1, 1, NULL); | ||||
|     usb_dev = dev; | ||||
|     hid_report.keyboard.report_id = ReportIdKeyboard; | ||||
|     hid_report.mouse.report_id = ReportIdMouse; | ||||
|  | ||||
|     usbd_reg_config(dev, hid_ep_config); | ||||
|     usbd_reg_control(dev, hid_control);     | ||||
| @@ -172,41 +288,34 @@ static void hid_deinit(usbd_device *dev) { | ||||
| } | ||||
|  | ||||
| static void hid_on_wakeup(usbd_device *dev) { | ||||
|     hid_connected = true; | ||||
| } | ||||
|  | ||||
| static void hid_on_suspend(usbd_device *dev) { | ||||
|     if (hid_connected == true) { | ||||
|         hid_connected = false; | ||||
|         osSemaphoreRelease(hid_semaphore); | ||||
|     } | ||||
| } | ||||
|  | ||||
| /* HID mouse IN endpoint callback */ | ||||
| static void hid_mouse_move(usbd_device *dev, uint8_t event, uint8_t ep) { | ||||
|     static uint8_t t = 0; | ||||
|     if (t < 0x10) { | ||||
|         hid_report_data.x = 1; | ||||
|         hid_report_data.y = 0; | ||||
|     } else if (t < 0x20) { | ||||
|         hid_report_data.x = 1; | ||||
|         hid_report_data.y = 1; | ||||
|     } else if (t < 0x30) { | ||||
|         hid_report_data.x = 0; | ||||
|         hid_report_data.y = 1; | ||||
|     } else if (t < 0x40) { | ||||
|         hid_report_data.x = -1; | ||||
|         hid_report_data.y = 1; | ||||
|     } else if (t < 0x50) { | ||||
|         hid_report_data.x = -1; | ||||
|         hid_report_data.y = 0; | ||||
|     } else if (t < 0x60) { | ||||
|         hid_report_data.x = -1; | ||||
|         hid_report_data.y = -1; | ||||
|     } else if (t < 0x70) { | ||||
|         hid_report_data.x = 0; | ||||
|         hid_report_data.y = -1; | ||||
|     } else  { | ||||
|         hid_report_data.x = 1; | ||||
|         hid_report_data.y = -1; | ||||
| static bool hid_send_report(uint8_t report_id) | ||||
| { | ||||
|     if ((hid_semaphore == NULL) || (hid_connected == false)) | ||||
|         return false; | ||||
|  | ||||
|     furi_check(osSemaphoreAcquire(hid_semaphore, osWaitForever) == osOK); | ||||
|     if (hid_connected == true) { | ||||
|         if (report_id == ReportIdKeyboard) | ||||
|             usbd_ep_write(usb_dev, HID_RIN_EP, &hid_report.keyboard, sizeof(hid_report.keyboard)); | ||||
|         else | ||||
|             usbd_ep_write(usb_dev, HID_RIN_EP, &hid_report.mouse, sizeof(hid_report.mouse)); | ||||
|         return true; | ||||
|     } | ||||
|     t = (t + 1) & 0x7F; | ||||
|     usbd_ep_write(dev, ep, &hid_report_data, sizeof(hid_report_data)); | ||||
|     return false; | ||||
| } | ||||
|  | ||||
| static void hid_ep_callback(usbd_device *dev, uint8_t event, uint8_t ep) { | ||||
|     osSemaphoreRelease(hid_semaphore); | ||||
| } | ||||
|  | ||||
| /* Configure endpoints */ | ||||
| @@ -220,7 +329,7 @@ static usbd_respond hid_ep_config (usbd_device *dev, uint8_t cfg) { | ||||
|     case 1: | ||||
|         /* configuring device */ | ||||
|         usbd_ep_config(dev, HID_RIN_EP, USB_EPTYPE_INTERRUPT, HID_RIN_SZ); | ||||
|         usbd_reg_endpoint(dev, HID_RIN_EP, hid_mouse_move); | ||||
|         usbd_reg_endpoint(dev, HID_RIN_EP, hid_ep_callback); | ||||
|         usbd_ep_write(dev, HID_RIN_EP, 0, 0); | ||||
|         return usbd_ack; | ||||
|     default: | ||||
| @@ -237,8 +346,8 @@ static usbd_respond hid_control (usbd_device *dev, usbd_ctlreq *req, usbd_rqc_ca | ||||
|         case USB_HID_SETIDLE: | ||||
|             return usbd_ack; | ||||
|         case USB_HID_GETREPORT: | ||||
|             dev->status.data_ptr = &hid_report_data; | ||||
|             dev->status.data_count = sizeof(hid_report_data); | ||||
|             dev->status.data_ptr = &hid_report; | ||||
|             dev->status.data_count = sizeof(hid_report); | ||||
|             return usbd_ack; | ||||
|         default: | ||||
|             return usbd_fail; | ||||
|   | ||||
| @@ -89,6 +89,10 @@ void furi_hal_usb_set_config(UsbMode new_mode) { | ||||
|     } | ||||
| } | ||||
|  | ||||
| UsbMode furi_hal_usb_get_config() { | ||||
|     return usb_config.mode_cur; | ||||
| } | ||||
|  | ||||
| void furi_hal_usb_disable() { | ||||
|     if (usb_config.enabled) { | ||||
|         susp_evt(&udev, 0, 0); | ||||
|   | ||||
		Reference in New Issue
	
	Block a user