372 lines
12 KiB
C
372 lines
12 KiB
C
/*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2019 Ha Thach (tinyusb.org)
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*
|
|
* This file is part of the TinyUSB stack.
|
|
*/
|
|
|
|
#include "tusb_option.h"
|
|
|
|
#if (TUSB_OPT_HOST_ENABLED && HOST_CLASS_HID)
|
|
|
|
#include "common/tusb_common.h"
|
|
#include "hid_host.h"
|
|
|
|
//--------------------------------------------------------------------+
|
|
// MACRO CONSTANT TYPEDEF
|
|
//--------------------------------------------------------------------+
|
|
|
|
/* "KEYBOARD" : in_len=8 , out_len=1, usage_page=0x01, usage=0x06 # Generic Desktop, Keyboard
|
|
"MOUSE" : in_len=4 , out_len=0, usage_page=0x01, usage=0x02 # Generic Desktop, Mouse
|
|
"CONSUMER" : in_len=2 , out_len=0, usage_page=0x0C, usage=0x01 # Consumer, Consumer Control
|
|
"SYS_CONTROL" : in_len=1 , out_len=0, usage_page=0x01, usage=0x80 # Generic Desktop, Sys Control
|
|
"GAMEPAD" : in_len=6 , out_len=0, usage_page=0x01, usage=0x05 # Generic Desktop, Game Pad
|
|
"DIGITIZER" : in_len=5 , out_len=0, usage_page=0x0D, usage=0x02 # Digitizers, Pen
|
|
"XAC_COMPATIBLE_GAMEPAD" : in_len=3 , out_len=0, usage_page=0x01, usage=0x05 # Generic Desktop, Game Pad
|
|
"RAW" : in_len=64, out_len=0, usage_page=0xFFAF, usage=0xAF # Vendor 0xFFAF "Adafruit", 0xAF
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t itf_num;
|
|
uint8_t ep_in;
|
|
uint8_t ep_out;
|
|
|
|
uint16_t report_desc_len;
|
|
|
|
bool valid;
|
|
uint16_t report_size; // TODO remove later
|
|
|
|
uint8_t boot_protocol; // None, Keyboard, Mouse
|
|
bool boot_mode; // Boot or Report protocol
|
|
uint8_t report_count; // Number of reports
|
|
|
|
struct {
|
|
uint8_t in_len; // length of IN report
|
|
uint8_t out_len; // length of OUT report
|
|
uint8_t usage_page;
|
|
uint8_t usage;
|
|
}reports[CFG_TUH_HID_REPORT_MAX];
|
|
|
|
// Parsed Report ID for convenient API
|
|
uint8_t rid_keyboard;
|
|
uint8_t rid_mouse;
|
|
uint8_t rid_gamepad;
|
|
uint8_t rid_consumer;
|
|
}hidh_interface_t;
|
|
|
|
typedef struct
|
|
{
|
|
uint8_t inst_count;
|
|
hidh_interface_t instance[CFG_TUH_HID];
|
|
} hidh_device_t;
|
|
|
|
static hidh_device_t _hidh_dev[CFG_TUSB_HOST_DEVICE_MAX-1];
|
|
|
|
#if 0
|
|
CFG_TUSB_MEM_SECTION uint8_t report_descriptor[256];
|
|
#endif
|
|
|
|
TU_ATTR_ALWAYS_INLINE static inline hidh_device_t* get_dev(uint8_t dev_addr)
|
|
{
|
|
return &_hidh_dev[dev_addr-1];
|
|
}
|
|
|
|
TU_ATTR_ALWAYS_INLINE static inline hidh_interface_t* get_instance(uint8_t dev_addr, uint8_t inst)
|
|
{
|
|
return &_hidh_dev[dev_addr-1].instance[inst];
|
|
}
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
// HID Interface common functions
|
|
//--------------------------------------------------------------------+
|
|
static inline bool hidh_interface_open(uint8_t rhport, uint8_t dev_addr, uint8_t interface_number, tusb_desc_endpoint_t const *desc_ep, hidh_interface_t *p_hid)
|
|
{
|
|
TU_ASSERT( usbh_edpt_open(rhport, dev_addr, desc_ep) );
|
|
|
|
p_hid->itf_num = interface_number;
|
|
p_hid->ep_in = desc_ep->bEndpointAddress;
|
|
p_hid->report_size = desc_ep->wMaxPacketSize.size; // TODO get size from report descriptor
|
|
p_hid->valid = true;
|
|
|
|
return true;
|
|
}
|
|
|
|
static inline void hidh_interface_close(hidh_interface_t *p_hid)
|
|
{
|
|
tu_memclr(p_hid, sizeof(hidh_interface_t));
|
|
}
|
|
|
|
// called from public API need to validate parameters
|
|
tusb_error_t hidh_interface_get_report(uint8_t dev_addr, void * report, hidh_interface_t *p_hid)
|
|
{
|
|
//------------- parameters validation -------------//
|
|
// TODO change to use is configured function
|
|
TU_ASSERT(TUSB_DEVICE_STATE_CONFIGURED == tuh_device_get_state(dev_addr), TUSB_ERROR_DEVICE_NOT_READY);
|
|
TU_VERIFY(report, TUSB_ERROR_INVALID_PARA);
|
|
TU_ASSERT(!hcd_edpt_busy(dev_addr, p_hid->ep_in), TUSB_ERROR_INTERFACE_IS_BUSY);
|
|
|
|
TU_ASSERT( usbh_edpt_xfer(dev_addr, p_hid->ep_in, report, p_hid->report_size) ) ;
|
|
|
|
return TUSB_ERROR_NONE;
|
|
}
|
|
|
|
//--------------------------------------------------------------------+
|
|
// KEYBOARD
|
|
//--------------------------------------------------------------------+
|
|
|
|
bool tuh_hid_keyboard_mounted(uint8_t dev_addr)
|
|
{
|
|
uint8_t itf = 0;
|
|
hidh_interface_t* hid_itf = get_instance(dev_addr, itf);
|
|
|
|
// TODO check rid_keyboard
|
|
return tuh_device_is_configured(dev_addr) && (hid_itf->ep_in != 0);
|
|
}
|
|
|
|
tusb_error_t tuh_hid_keyboard_get_report(uint8_t dev_addr, void* buffer)
|
|
{
|
|
uint8_t itf = 0;
|
|
hidh_interface_t* hid_itf = get_instance(dev_addr, itf);
|
|
|
|
return hidh_interface_get_report(dev_addr, buffer, hid_itf);
|
|
}
|
|
|
|
bool tuh_hid_keyboard_is_busy(uint8_t dev_addr)
|
|
{
|
|
uint8_t itf = 0;
|
|
hidh_interface_t* hid_itf = get_instance(dev_addr, itf);
|
|
|
|
return tuh_hid_keyboard_mounted(dev_addr) && hcd_edpt_busy(dev_addr, hid_itf->ep_in);
|
|
}
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
// MOUSE
|
|
//--------------------------------------------------------------------+
|
|
#if CFG_TUH_HID_MOUSE
|
|
|
|
static hidh_interface_t mouseh_data[CFG_TUSB_HOST_DEVICE_MAX]; // does not have addr0, index = dev_address-1
|
|
|
|
//------------- Public API -------------//
|
|
bool tuh_hid_mouse_mounted(uint8_t dev_addr)
|
|
{
|
|
return tuh_device_is_configured(dev_addr) && (mouseh_data[dev_addr-1].ep_in != 0);
|
|
}
|
|
|
|
bool tuh_hid_mouse_is_busy(uint8_t dev_addr)
|
|
{
|
|
return tuh_hid_mouse_mounted(dev_addr) && hcd_edpt_busy(dev_addr, mouseh_data[dev_addr-1].ep_in);
|
|
}
|
|
|
|
tusb_error_t tuh_hid_mouse_get_report(uint8_t dev_addr, void * report)
|
|
{
|
|
return hidh_interface_get_report(dev_addr, report, &mouseh_data[dev_addr-1]);
|
|
}
|
|
|
|
#endif
|
|
|
|
//--------------------------------------------------------------------+
|
|
// GENERIC
|
|
//--------------------------------------------------------------------+
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
// CLASS-USBH API (don't require to verify parameters)
|
|
//--------------------------------------------------------------------+
|
|
void hidh_init(void)
|
|
{
|
|
tu_memclr(_hidh_dev, sizeof(_hidh_dev));
|
|
|
|
#if CFG_TUH_HID_MOUSE
|
|
tu_memclr(&mouseh_data, sizeof(hidh_interface_t)*CFG_TUSB_HOST_DEVICE_MAX);
|
|
#endif
|
|
}
|
|
|
|
bool hidh_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *desc_itf, uint16_t *p_length)
|
|
{
|
|
TU_VERIFY(TUSB_CLASS_HID == desc_itf->bInterfaceClass);
|
|
|
|
uint8_t const *p_desc = (uint8_t const *) desc_itf;
|
|
|
|
//------------- HID descriptor -------------//
|
|
p_desc = tu_desc_next(p_desc);
|
|
tusb_hid_descriptor_hid_t const *desc_hid = (tusb_hid_descriptor_hid_t const *) p_desc;
|
|
TU_ASSERT(HID_DESC_TYPE_HID == desc_hid->bDescriptorType);
|
|
|
|
// not enough interface, try to increase CFG_TUH_HID
|
|
// TODO multiple devices
|
|
hidh_device_t* hid_dev = get_dev(dev_addr);
|
|
TU_ASSERT(hid_dev->inst_count < CFG_TUH_HID);
|
|
|
|
hidh_interface_t* hid_itf = get_instance(dev_addr, hid_dev->inst_count);
|
|
hid_dev->inst_count++;
|
|
|
|
hid_itf->itf_num = desc_itf->bInterfaceNumber;
|
|
hid_itf->boot_mode = false; // default is report mode
|
|
hid_itf->report_desc_len = tu_unaligned_read16(&desc_hid->wReportLength);
|
|
|
|
//------------- Endpoint Descriptor -------------//
|
|
p_desc = tu_desc_next(p_desc);
|
|
tusb_desc_endpoint_t const * desc_ep = (tusb_desc_endpoint_t const *) p_desc;
|
|
TU_ASSERT(TUSB_DESC_ENDPOINT == desc_ep->bDescriptorType);
|
|
|
|
if ( HID_SUBCLASS_BOOT == desc_itf->bInterfaceSubClass )
|
|
{
|
|
hid_itf->boot_protocol = desc_itf->bInterfaceProtocol;
|
|
|
|
#if CFG_TUH_HID_KEYBOARD
|
|
if ( HID_PROTOCOL_KEYBOARD == desc_itf->bInterfaceProtocol)
|
|
{
|
|
TU_ASSERT( hidh_interface_open(rhport, dev_addr, desc_itf->bInterfaceNumber, desc_ep, hid_itf) );
|
|
TU_LOG2_HEX(hid_itf->ep_in);
|
|
|
|
hid_itf->report_count = 1;
|
|
|
|
hid_itf->reports[0].usage_page = HID_USAGE_PAGE_DESKTOP;
|
|
hid_itf->reports[0].usage = HID_USAGE_DESKTOP_KEYBOARD;
|
|
hid_itf->reports[0].in_len = 8;
|
|
hid_itf->reports[0].out_len = 1;
|
|
} else
|
|
#endif
|
|
|
|
#if CFG_TUH_HID_MOUSE
|
|
if ( HID_PROTOCOL_MOUSE == desc_itf->bInterfaceProtocol)
|
|
{
|
|
TU_ASSERT ( hidh_interface_open(rhport, dev_addr, desc_itf->bInterfaceNumber, desc_ep, &mouseh_data[dev_addr-1]) );
|
|
TU_LOG2_HEX(mouseh_data[dev_addr-1].ep_in);
|
|
} else
|
|
#endif
|
|
|
|
{
|
|
// Not supported protocol
|
|
return false;
|
|
}
|
|
}
|
|
|
|
*p_length = sizeof(tusb_desc_interface_t) + sizeof(tusb_hid_descriptor_hid_t) + desc_itf->bNumEndpoints*sizeof(tusb_desc_endpoint_t);
|
|
|
|
return true;
|
|
}
|
|
|
|
bool hidh_set_config(uint8_t dev_addr, uint8_t itf_num)
|
|
{
|
|
#if 0
|
|
//------------- Get Report Descriptor TODO HID parser -------------//
|
|
if ( p_desc_hid->bNumDescriptors )
|
|
{
|
|
STASK_INVOKE(
|
|
usbh_control_xfer_subtask( dev_addr, bm_request_type(TUSB_DIR_IN, TUSB_REQ_TYPE_STANDARD, TUSB_REQ_RCPT_INTERFACE),
|
|
TUSB_REQ_GET_DESCRIPTOR, (p_desc_hid->bReportType << 8), 0,
|
|
p_desc_hid->wReportLength, report_descriptor ),
|
|
error
|
|
);
|
|
(void) error; // if error in getting report descriptor --> treating like there is none
|
|
}
|
|
#endif
|
|
|
|
#if 0
|
|
// SET IDLE = 0 request
|
|
// Device can stall if not support this request
|
|
tusb_control_request_t const request =
|
|
{
|
|
.bmRequestType_bit =
|
|
{
|
|
.recipient = TUSB_REQ_RCPT_INTERFACE,
|
|
.type = TUSB_REQ_TYPE_CLASS,
|
|
.direction = TUSB_DIR_OUT
|
|
},
|
|
.bRequest = HID_REQ_CONTROL_SET_IDLE,
|
|
.wValue = 0, // idle_rate = 0
|
|
.wIndex = p_interface_desc->bInterfaceNumber,
|
|
.wLength = 0
|
|
};
|
|
|
|
// stall is a valid response for SET_IDLE, therefore we could ignore result of this request
|
|
tuh_control_xfer(dev_addr, &request, NULL, NULL);
|
|
#endif
|
|
|
|
usbh_driver_set_config_complete(dev_addr, itf_num);
|
|
|
|
// uint8_t itf = 0;
|
|
// hidh_interface_t* hid_itf = &_hidh_itf[itf];
|
|
|
|
|
|
if (itf_num == 0 ) {
|
|
if (tuh_hid_mounted_cb) tuh_hid_mounted_cb(dev_addr);
|
|
}
|
|
|
|
#if CFG_TUH_HID_MOUSE
|
|
if (( mouseh_data[dev_addr-1].ep_in == itf_num ) && mouseh_data[dev_addr-1].valid)
|
|
{
|
|
tuh_hid_mouse_mounted_cb(dev_addr);
|
|
}
|
|
#endif
|
|
|
|
return true;
|
|
}
|
|
|
|
bool hidh_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes)
|
|
{
|
|
(void) xferred_bytes; // TODO may need to use this para later
|
|
|
|
// uint8_t itf = 0;
|
|
// hidh_interface_t* hid_itf = &_hidh_itf[itf];
|
|
|
|
#if CFG_TUH_HID_KEYBOARD
|
|
// if ( ep_addr == keyboardh_data[dev_addr-1].ep_in )
|
|
// {
|
|
// tuh_hid_keyboard_isr(dev_addr, event);
|
|
// return true;
|
|
// }
|
|
#endif
|
|
|
|
#if CFG_TUH_HID_MOUSE
|
|
if ( ep_addr == mouseh_data[dev_addr-1].ep_in )
|
|
{
|
|
tuh_hid_mouse_isr(dev_addr, event);
|
|
return true;
|
|
}
|
|
#endif
|
|
|
|
return true;
|
|
}
|
|
|
|
void hidh_close(uint8_t dev_addr)
|
|
{
|
|
uint8_t itf = 0;
|
|
hidh_interface_t* hid_itf = get_instance(dev_addr, itf);
|
|
|
|
if (tuh_hid_unmounted_cb) tuh_hid_unmounted_cb(dev_addr);
|
|
hidh_interface_close(hid_itf);
|
|
|
|
#if CFG_TUH_HID_MOUSE
|
|
if( mouseh_data[dev_addr-1].ep_in != 0 )
|
|
{
|
|
hidh_interface_close(&mouseh_data[dev_addr-1]);
|
|
tuh_hid_mouse_unmounted_cb( dev_addr );
|
|
}
|
|
#endif
|
|
}
|
|
|
|
#endif
|