2020-01-14 23:30:39 -05:00
|
|
|
/*
|
|
|
|
|
* 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.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _TUSB_HID_DEVICE_H_
|
|
|
|
|
#define _TUSB_HID_DEVICE_H_
|
|
|
|
|
|
|
|
|
|
#include "common/tusb_common.h"
|
|
|
|
|
#include "device/usbd.h"
|
|
|
|
|
#include "hid.h"
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
extern "C" {
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
|
// Class Driver Default Configure & Validation
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
|
|
|
|
|
|
#ifndef CFG_TUD_HID_BUFSIZE
|
|
|
|
|
#define CFG_TUD_HID_BUFSIZE 16
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
|
// Application API
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
|
|
|
|
|
|
// Check if the interface is ready to use
|
|
|
|
|
bool tud_hid_ready(void);
|
|
|
|
|
|
|
|
|
|
// Check if current mode is Boot (true) or Report (false)
|
|
|
|
|
bool tud_hid_boot_mode(void);
|
|
|
|
|
|
|
|
|
|
// Send report to host
|
|
|
|
|
bool tud_hid_report(uint8_t report_id, void const* report, uint8_t len);
|
|
|
|
|
|
|
|
|
|
// KEYBOARD: convenient helper to send keyboard report if application
|
|
|
|
|
// use template layout report as defined by hid_keyboard_report_t
|
|
|
|
|
bool tud_hid_keyboard_report(uint8_t report_id, uint8_t modifier, uint8_t keycode[6]);
|
|
|
|
|
|
|
|
|
|
// MOUSE: convenient helper to send mouse report if application
|
|
|
|
|
// use template layout report as defined by hid_mouse_report_t
|
|
|
|
|
bool tud_hid_mouse_report(uint8_t report_id, uint8_t buttons, int8_t x, int8_t y, int8_t vertical, int8_t horizontal);
|
|
|
|
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
|
// Callbacks (Weak is optional)
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
|
|
|
|
|
|
// Invoked when received GET HID REPORT DESCRIPTOR request
|
|
|
|
|
// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
|
|
|
|
|
uint8_t const * tud_hid_descriptor_report_cb(void);
|
|
|
|
|
|
|
|
|
|
// Invoked when received GET_REPORT control request
|
|
|
|
|
// Application must fill buffer report's content and return its length.
|
|
|
|
|
// Return zero will cause the stack to STALL request
|
|
|
|
|
uint16_t tud_hid_get_report_cb(uint8_t report_id, hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen);
|
|
|
|
|
|
|
|
|
|
// Invoked when received SET_REPORT control request or
|
|
|
|
|
// received data on OUT endpoint ( Report ID = 0, Type = 0 )
|
|
|
|
|
void tud_hid_set_report_cb(uint8_t report_id, hid_report_type_t report_type, uint8_t const* buffer, uint16_t bufsize);
|
|
|
|
|
|
|
|
|
|
// Invoked when received SET_PROTOCOL request ( mode switch Boot <-> Report )
|
|
|
|
|
TU_ATTR_WEAK void tud_hid_boot_mode_cb(uint8_t boot_mode);
|
|
|
|
|
|
|
|
|
|
// Invoked when received SET_IDLE request. return false will stall the request
|
|
|
|
|
// - Idle Rate = 0 : only send report if there is changes, i.e skip duplication
|
|
|
|
|
// - Idle Rate > 0 : skip duplication, but send at least 1 report every idle rate (in unit of 4 ms).
|
|
|
|
|
TU_ATTR_WEAK bool tud_hid_set_idle_cb(uint8_t idle_rate);
|
|
|
|
|
|
|
|
|
|
/* --------------------------------------------------------------------+
|
|
|
|
|
* HID Report Descriptor Template
|
|
|
|
|
*
|
|
|
|
|
* Convenient for declaring popular HID device (keyboard, mouse, consumer,
|
2020-04-20 16:09:17 +07:00
|
|
|
* gamepad etc...). Templates take "HID_REPORT_ID(n)" as input, leave
|
2020-01-14 23:30:39 -05:00
|
|
|
* empty if multiple reports is not used
|
|
|
|
|
*
|
|
|
|
|
* - Only 1 report: no parameter
|
|
|
|
|
* uint8_t const report_desc[] = { TUD_HID_REPORT_DESC_KEYBOARD() };
|
|
|
|
|
*
|
2020-04-20 16:09:17 +07:00
|
|
|
* - Multiple Reports: "HID_REPORT_ID(ID)" must be passed to template
|
2020-01-14 23:30:39 -05:00
|
|
|
* uint8_t const report_desc[] =
|
|
|
|
|
* {
|
2020-04-20 16:09:17 +07:00
|
|
|
* TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(1) ) ,
|
|
|
|
|
* TUD_HID_REPORT_DESC_MOUSE ( HID_REPORT_ID(2) )
|
2020-01-14 23:30:39 -05:00
|
|
|
* };
|
|
|
|
|
*--------------------------------------------------------------------*/
|
|
|
|
|
|
|
|
|
|
// Keyboard Report Descriptor Template
|
|
|
|
|
#define TUD_HID_REPORT_DESC_KEYBOARD(...) \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_KEYBOARD ) ,\
|
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
|
|
|
|
|
/* Report ID if any */\
|
|
|
|
|
__VA_ARGS__ \
|
|
|
|
|
/* 8 bits Modifier Keys (Shfit, Control, Alt) */ \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD ) ,\
|
|
|
|
|
HID_USAGE_MIN ( 224 ) ,\
|
|
|
|
|
HID_USAGE_MAX ( 231 ) ,\
|
|
|
|
|
HID_LOGICAL_MIN ( 0 ) ,\
|
|
|
|
|
HID_LOGICAL_MAX ( 1 ) ,\
|
|
|
|
|
HID_REPORT_COUNT ( 8 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 1 ) ,\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
|
|
|
|
|
/* 8 bit reserved */ \
|
|
|
|
|
HID_REPORT_COUNT ( 1 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
|
HID_INPUT ( HID_CONSTANT ) ,\
|
|
|
|
|
/* 6-byte Keycodes */ \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD ) ,\
|
|
|
|
|
HID_USAGE_MIN ( 0 ) ,\
|
|
|
|
|
HID_USAGE_MAX ( 255 ) ,\
|
|
|
|
|
HID_LOGICAL_MIN ( 0 ) ,\
|
|
|
|
|
HID_LOGICAL_MAX ( 255 ) ,\
|
|
|
|
|
HID_REPORT_COUNT ( 6 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
|
|
|
|
|
/* 5-bit LED Indicator Kana | Compose | ScrollLock | CapsLock | NumLock */ \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_LED ) ,\
|
|
|
|
|
HID_USAGE_MIN ( 1 ) ,\
|
|
|
|
|
HID_USAGE_MAX ( 5 ) ,\
|
|
|
|
|
HID_REPORT_COUNT ( 5 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 1 ) ,\
|
|
|
|
|
HID_OUTPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
|
|
|
|
|
/* led padding */ \
|
|
|
|
|
HID_REPORT_COUNT ( 1 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 3 ) ,\
|
|
|
|
|
HID_OUTPUT ( HID_CONSTANT ) ,\
|
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
|
|
|
|
|
// Mouse Report Descriptor Template
|
|
|
|
|
#define TUD_HID_REPORT_DESC_MOUSE(...) \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_MOUSE ) ,\
|
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
|
|
|
|
|
/* Report ID if any */\
|
|
|
|
|
__VA_ARGS__ \
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_POINTER ) ,\
|
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_PHYSICAL ) ,\
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_BUTTON ) ,\
|
|
|
|
|
HID_USAGE_MIN ( 1 ) ,\
|
|
|
|
|
HID_USAGE_MAX ( 5 ) ,\
|
|
|
|
|
HID_LOGICAL_MIN ( 0 ) ,\
|
|
|
|
|
HID_LOGICAL_MAX ( 1 ) ,\
|
|
|
|
|
/* Left, Right, Middle, Backward, Forward buttons */ \
|
|
|
|
|
HID_REPORT_COUNT( 5 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 1 ) ,\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
|
|
|
|
|
/* 3 bit padding */ \
|
|
|
|
|
HID_REPORT_COUNT( 1 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 3 ) ,\
|
|
|
|
|
HID_INPUT ( HID_CONSTANT ) ,\
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
|
|
|
|
|
/* X, Y position [-127, 127] */ \
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_X ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_Y ) ,\
|
|
|
|
|
HID_LOGICAL_MIN ( 0x81 ) ,\
|
|
|
|
|
HID_LOGICAL_MAX ( 0x7f ) ,\
|
|
|
|
|
HID_REPORT_COUNT( 2 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ) ,\
|
|
|
|
|
/* Verital wheel scroll [-127, 127] */ \
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_WHEEL ) ,\
|
|
|
|
|
HID_LOGICAL_MIN ( 0x81 ) ,\
|
|
|
|
|
HID_LOGICAL_MAX ( 0x7f ) ,\
|
|
|
|
|
HID_REPORT_COUNT( 1 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ) ,\
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_CONSUMER ), \
|
|
|
|
|
/* Horizontal wheel scroll [-127, 127] */ \
|
|
|
|
|
HID_USAGE_N ( HID_USAGE_CONSUMER_AC_PAN, 2 ), \
|
|
|
|
|
HID_LOGICAL_MIN ( 0x81 ), \
|
|
|
|
|
HID_LOGICAL_MAX ( 0x7f ), \
|
|
|
|
|
HID_REPORT_COUNT( 1 ), \
|
|
|
|
|
HID_REPORT_SIZE ( 8 ), \
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ), \
|
|
|
|
|
HID_COLLECTION_END , \
|
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
|
|
|
|
|
// Consumer Control Report Descriptor Template
|
|
|
|
|
#define TUD_HID_REPORT_DESC_CONSUMER(...) \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_CONSUMER ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_CONSUMER_CONTROL ) ,\
|
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
|
|
|
|
|
/* Report ID if any */\
|
|
|
|
|
__VA_ARGS__ \
|
|
|
|
|
HID_LOGICAL_MIN ( 0x00 ) ,\
|
|
|
|
|
HID_LOGICAL_MAX_N( 0x03FF, 2 ) ,\
|
|
|
|
|
HID_USAGE_MIN ( 0x00 ) ,\
|
|
|
|
|
HID_USAGE_MAX_N ( 0x03FF, 2 ) ,\
|
|
|
|
|
HID_REPORT_COUNT ( 1 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 16 ) ,\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
|
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
|
|
|
|
|
/* System Control Report Descriptor Template
|
|
|
|
|
* 0x00 - do nothing
|
|
|
|
|
* 0x01 - Power Off
|
|
|
|
|
* 0x02 - Standby
|
|
|
|
|
* 0x04 - Wake Host
|
|
|
|
|
*/
|
|
|
|
|
#define TUD_HID_REPORT_DESC_SYSTEM_CONTROL(...) \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_SYSTEM_CONTROL ) ,\
|
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
|
|
|
|
|
/* Report ID if any */\
|
|
|
|
|
__VA_ARGS__ \
|
|
|
|
|
/* 2 bit system power control */ \
|
|
|
|
|
HID_LOGICAL_MIN ( 1 ) ,\
|
|
|
|
|
HID_LOGICAL_MAX ( 3 ) ,\
|
|
|
|
|
HID_REPORT_COUNT ( 1 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 2 ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_SYSTEM_SLEEP ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_SYSTEM_POWER_DOWN ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_SYSTEM_WAKE_UP ) ,\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
|
|
|
|
|
/* 6 bit padding */ \
|
|
|
|
|
HID_REPORT_COUNT ( 1 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 6 ) ,\
|
|
|
|
|
HID_INPUT ( HID_CONSTANT ) ,\
|
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
|
|
|
|
|
// Gamepad Report Descriptor Template
|
|
|
|
|
// with 16 buttons and 2 joysticks with following layout
|
|
|
|
|
// | Button Map (2 bytes) | X | Y | Z | Rz
|
|
|
|
|
#define TUD_HID_REPORT_DESC_GAMEPAD(...) \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_GAMEPAD ) ,\
|
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
|
|
|
|
|
/* Report ID if any */\
|
|
|
|
|
__VA_ARGS__ \
|
|
|
|
|
/* 16 bit Button Map */ \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_BUTTON ) ,\
|
|
|
|
|
HID_USAGE_MIN ( 1 ) ,\
|
|
|
|
|
HID_USAGE_MAX ( 16 ) ,\
|
|
|
|
|
HID_LOGICAL_MIN ( 0 ) ,\
|
|
|
|
|
HID_LOGICAL_MAX ( 1 ) ,\
|
|
|
|
|
HID_REPORT_COUNT ( 16 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 1 ) ,\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
|
|
|
|
|
/* X, Y, Z, Rz (min -127, max 127 ) */ \
|
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
|
|
|
|
|
HID_LOGICAL_MIN ( 0x81 ) ,\
|
|
|
|
|
HID_LOGICAL_MAX ( 0x7f ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_X ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_Y ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_Z ) ,\
|
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_RZ ) ,\
|
|
|
|
|
HID_REPORT_COUNT ( 4 ) ,\
|
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
|
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
|
|
|
|
|
// HID Generic Input & Output
|
|
|
|
|
// - 1st parameter is report size (mandatory)
|
|
|
|
|
// - 2nd parameter is report id HID_REPORT_ID(n) (optional)
|
|
|
|
|
#define TUD_HID_REPORT_DESC_GENERIC_INOUT(report_size, ...) \
|
|
|
|
|
HID_USAGE_PAGE_N ( HID_USAGE_PAGE_VENDOR, 2 ),\
|
|
|
|
|
HID_USAGE ( 0x01 ),\
|
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ),\
|
|
|
|
|
/* Report ID if any */\
|
|
|
|
|
__VA_ARGS__ \
|
|
|
|
|
/* Input */ \
|
|
|
|
|
HID_USAGE ( 0x02 ),\
|
|
|
|
|
HID_LOGICAL_MIN ( 0x00 ),\
|
|
|
|
|
HID_LOGICAL_MAX ( 0xff ),\
|
|
|
|
|
HID_REPORT_SIZE ( 8 ),\
|
|
|
|
|
HID_REPORT_COUNT( report_size ),\
|
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
|
|
|
|
|
/* Output */ \
|
|
|
|
|
HID_USAGE ( 0x03 ),\
|
|
|
|
|
HID_LOGICAL_MIN ( 0x00 ),\
|
|
|
|
|
HID_LOGICAL_MAX ( 0xff ),\
|
|
|
|
|
HID_REPORT_SIZE ( 8 ),\
|
|
|
|
|
HID_REPORT_COUNT( report_size ),\
|
|
|
|
|
HID_OUTPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
|
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
|
|
|
|
|
//--------------------------------------------------------------------+
|
|
|
|
|
// Internal Class Driver API
|
|
|
|
|
//--------------------------------------------------------------------+
|
2020-05-28 11:19:12 +07:00
|
|
|
void hidd_init (void);
|
|
|
|
|
void hidd_reset (uint8_t rhport);
|
|
|
|
|
uint16_t hidd_open (uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len);
|
|
|
|
|
bool hidd_control_request (uint8_t rhport, tusb_control_request_t const * request);
|
|
|
|
|
bool hidd_control_complete (uint8_t rhport, tusb_control_request_t const * request);
|
|
|
|
|
bool hidd_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes);
|
2020-01-14 23:30:39 -05:00
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#endif /* _TUSB_HID_DEVICE_H_ */
|
|
|
|
|
|
