mirror of
https://github.com/trezor/trezor-firmware.git
synced 2024-11-30 11:28:21 +00:00
81 lines
3.0 KiB
C
81 lines
3.0 KiB
C
/*
|
|
* Copyright (c) Jan Pochyla, SatoshiLabs
|
|
*
|
|
* Licensed under TREZOR License
|
|
* see LICENSE file for details
|
|
*/
|
|
|
|
typedef struct __attribute__((packed)) {
|
|
uint8_t bLength;
|
|
uint8_t bDescriptorType;
|
|
uint16_t bcdHID;
|
|
uint8_t bCountryCode;
|
|
uint8_t bNumDescriptors;
|
|
uint8_t bReportDescriptorType;
|
|
uint16_t wReportDescriptorLength;
|
|
} usb_hid_descriptor_t;
|
|
|
|
typedef struct __attribute__((packed)) {
|
|
usb_interface_descriptor_t iface;
|
|
usb_hid_descriptor_t hid;
|
|
usb_endpoint_descriptor_t ep_in;
|
|
usb_endpoint_descriptor_t ep_out;
|
|
} usb_hid_descriptor_block_t;
|
|
|
|
typedef enum {
|
|
USB_HID_SUBCLASS_NONE = 0,
|
|
USB_HID_SUBCLASS_BOOT = 1,
|
|
} usb_hid_subclass_t;
|
|
|
|
typedef enum {
|
|
USB_HID_PROTOCOL_NONE = 0,
|
|
USB_HID_PROTOCOL_KEYBOARD = 1,
|
|
USB_HID_PROTOCOL_MOUSE = 2,
|
|
} usb_hid_protocol_t;
|
|
|
|
/* usb_hid_info_t contains all information for setting up a HID interface. All
|
|
* passed pointers need to live at least until the interface is disabled
|
|
* (usb_stop is called). */
|
|
typedef struct {
|
|
const uint8_t *report_desc; // With length of report_desc_len bytes
|
|
uint8_t *rx_buffer; // With length of max_packet_len bytes
|
|
uint8_t iface_num; // Address of this HID interface
|
|
uint8_t ep_in; // Address of IN endpoint (with the highest bit set)
|
|
uint8_t ep_out; // Address of OUT endpoint
|
|
uint8_t subclass; // usb_iface_subclass_t
|
|
uint8_t protocol; // usb_iface_protocol_t
|
|
uint8_t polling_interval; // In units of 1ms
|
|
uint8_t max_packet_len; // Length of the biggest report and of rx_buffer
|
|
uint8_t report_desc_len; // Length of report_desc
|
|
} usb_hid_info_t;
|
|
|
|
/* usb_hid_state_t encapsulates all state used by enabled HID interface. It
|
|
* needs to be completely initialized in usb_hid_add and reset in
|
|
* usb_hid_class_init. See usb_hid_info_t for details of the configuration
|
|
* fields. */
|
|
typedef struct {
|
|
const usb_hid_descriptor_block_t *desc_block;
|
|
const uint8_t *report_desc;
|
|
uint8_t *rx_buffer;
|
|
uint8_t ep_in;
|
|
uint8_t ep_out;
|
|
uint8_t max_packet_len;
|
|
uint8_t report_desc_len;
|
|
|
|
uint8_t protocol; // For SET_PROTOCOL/GET_PROTOCOL setup reqs
|
|
uint8_t idle_rate; // For SET_IDLE/GET_IDLE setup reqs
|
|
uint8_t alt_setting; // For SET_INTERFACE/GET_INTERFACE setup reqs
|
|
uint8_t last_read_len; // Length of data read into rx_buffer
|
|
uint8_t ep_in_is_idle; // Set to 1 after IN endpoint gets idle
|
|
} usb_hid_state_t;
|
|
|
|
secbool usb_hid_add(const usb_hid_info_t *hid_info);
|
|
secbool usb_hid_can_read(uint8_t iface_num);
|
|
secbool usb_hid_can_write(uint8_t iface_num);
|
|
int usb_hid_read(uint8_t iface_num, uint8_t *buf, uint32_t len);
|
|
int usb_hid_write(uint8_t iface_num, const uint8_t *buf, uint32_t len);
|
|
|
|
int usb_hid_read_select(uint32_t timeout);
|
|
int usb_hid_read_blocking(uint8_t iface_num, uint8_t *buf, uint32_t len, int timeout);
|
|
int usb_hid_write_blocking(uint8_t iface_num, const uint8_t *buf, uint32_t len, int timeout);
|