2024-08-04 01:03:38 +08:00
|
|
|
/*
|
2023-12-25 06:22:05 +08: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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef USB_DESCRIPTORS_H_
|
|
|
|
#define USB_DESCRIPTORS_H_
|
|
|
|
|
2024-07-29 04:24:28 +08:00
|
|
|
// Interface 0
|
|
|
|
#define REPORT_ID_KEYBOARD 1
|
|
|
|
#define REPORT_ID_MOUSE 2
|
|
|
|
#define REPORT_ID_CONSUMER 3
|
|
|
|
#define REPORT_ID_SYSTEM 4
|
2023-12-25 06:22:05 +08:00
|
|
|
|
2024-07-29 04:24:28 +08:00
|
|
|
// Interface 1
|
2024-08-24 06:12:49 +08:00
|
|
|
#define REPORT_ID_RELMOUSE 5
|
|
|
|
#define REPORT_ID_DIGITIZER 7
|
2024-03-23 02:48:49 +08:00
|
|
|
|
2024-07-29 04:24:28 +08:00
|
|
|
// Interface 2
|
|
|
|
#define REPORT_ID_VENDOR 6
|
|
|
|
|
|
|
|
|
|
|
|
#define DEVICE_DESCRIPTOR(vid, pid) \
|
|
|
|
{.bLength = sizeof(tusb_desc_device_t),\
|
|
|
|
.bDescriptorType = TUSB_DESC_DEVICE,\
|
|
|
|
.bcdUSB = 0x0200,\
|
|
|
|
.bDeviceClass = 0x00,\
|
|
|
|
.bDeviceSubClass = 0x00,\
|
|
|
|
.bDeviceProtocol = 0x00,\
|
|
|
|
.bMaxPacketSize0 = CFG_TUD_ENDPOINT0_SIZE,\
|
|
|
|
.idVendor = vid,\
|
|
|
|
.idProduct = pid,\
|
|
|
|
.bcdDevice = 0x0100,\
|
|
|
|
.iManufacturer = 0x01,\
|
|
|
|
.iProduct = 0x02,\
|
|
|
|
.iSerialNumber = 0x03,\
|
|
|
|
.bNumConfigurations = 0x01}\
|
|
|
|
|
|
|
|
|
|
|
|
#define TUD_HID_REPORT_DESC_ABS_MOUSE(...) \
|
2023-12-25 06:22:05 +08:00
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_MOUSE ) ,\
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
|
2024-01-21 08:45:22 +08:00
|
|
|
/* Report ID */\
|
2023-12-25 06:22:05 +08:00
|
|
|
__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 ) ,\
|
2024-01-21 08:45:22 +08:00
|
|
|
\
|
2023-12-25 06:22:05 +08:00
|
|
|
/* Left, Right, Middle, Backward, Forward buttons */ \
|
|
|
|
HID_REPORT_COUNT( 5 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 1 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
|
2024-01-21 08:45:22 +08:00
|
|
|
\
|
2023-12-25 06:22:05 +08:00
|
|
|
/* 3 bit padding */ \
|
|
|
|
HID_REPORT_COUNT( 1 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 3 ) ,\
|
|
|
|
HID_INPUT ( HID_CONSTANT ) ,\
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
|
2024-01-21 08:45:22 +08:00
|
|
|
\
|
2023-12-25 06:22:05 +08:00
|
|
|
/* X, Y absolute position [0, 32767] */ \
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_X ) ,\
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_Y ) ,\
|
|
|
|
HID_LOGICAL_MIN ( 0x00 ) ,\
|
|
|
|
HID_LOGICAL_MAX_N( 0x7FFF, 2 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 16 ) ,\
|
|
|
|
HID_REPORT_COUNT ( 2 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
|
2024-01-21 08:45:22 +08:00
|
|
|
\
|
2023-12-25 06:22:05 +08:00
|
|
|
/* Vertical 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 ) ,\
|
2024-01-21 08:45:22 +08:00
|
|
|
\
|
2024-11-17 08:28:33 +08:00
|
|
|
/* Horizontal wheel (AC Pan) */ \
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_CONSUMER ) ,\
|
|
|
|
HID_LOGICAL_MIN ( 0x81 ) ,\
|
|
|
|
HID_LOGICAL_MAX ( 0x7f ) ,\
|
|
|
|
HID_REPORT_COUNT( 1 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
HID_USAGE_N ( HID_USAGE_CONSUMER_AC_PAN, 2 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ) ,\
|
|
|
|
\
|
2024-03-23 02:48:49 +08:00
|
|
|
/* Mouse mode (0 = absolute, 1 = relative) */ \
|
2023-12-25 06:22:05 +08:00
|
|
|
HID_REPORT_COUNT( 1 ), \
|
|
|
|
HID_REPORT_SIZE ( 8 ), \
|
2024-03-23 02:48:49 +08:00
|
|
|
HID_INPUT ( HID_CONSTANT ), \
|
2023-12-25 06:22:05 +08:00
|
|
|
HID_COLLECTION_END , \
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
2024-05-13 19:53:38 +08:00
|
|
|
// Consumer Control Report Descriptor Template
|
|
|
|
#define TUD_HID_REPORT_DESC_CONSUMER_CTRL(...) \
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_CONSUMER ) ,\
|
|
|
|
HID_USAGE ( HID_USAGE_CONSUMER_CONTROL ) ,\
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
|
|
|
|
/* Report ID if any */\
|
|
|
|
__VA_ARGS__ \
|
2024-07-29 04:24:28 +08:00
|
|
|
HID_LOGICAL_MIN ( 0x00 ) ,\
|
2024-05-13 19:53:38 +08:00
|
|
|
HID_LOGICAL_MAX_N( 0x0FFF, 2 ) ,\
|
2024-07-29 04:24:28 +08:00
|
|
|
HID_USAGE_MIN ( 0x00 ) ,\
|
2024-05-13 19:53:38 +08:00
|
|
|
HID_USAGE_MAX_N ( 0x0FFF, 2 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 16 ) ,\
|
|
|
|
HID_REPORT_COUNT ( 2 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
2024-07-29 04:24:28 +08:00
|
|
|
// System Control Report Descriptor Template
|
|
|
|
#define TUD_HID_REPORT_DESC_SYSTEM_CTRL(...) \
|
|
|
|
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__ \
|
|
|
|
HID_LOGICAL_MIN ( 0x00 ) ,\
|
|
|
|
HID_LOGICAL_MAX ( 0xff ) ,\
|
|
|
|
HID_REPORT_COUNT( 1 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
|
|
|
// Vendor Config Descriptor Template
|
|
|
|
#define TUD_HID_REPORT_DESC_VENDOR_CTRL(...) \
|
|
|
|
HID_USAGE_PAGE_N ( HID_USAGE_PAGE_VENDOR, 2 ) ,\
|
|
|
|
HID_USAGE ( 0x10 ) ,\
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
|
|
|
|
/* Report ID if any */\
|
|
|
|
__VA_ARGS__ \
|
|
|
|
HID_LOGICAL_MIN ( 0x80 ) ,\
|
|
|
|
HID_LOGICAL_MAX ( 0x7f ) ,\
|
|
|
|
HID_REPORT_COUNT( 12 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
HID_USAGE ( 0x10 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
|
|
|
|
HID_USAGE ( 0x10 ) ,\
|
|
|
|
HID_OUTPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
2024-08-18 00:47:36 +08:00
|
|
|
#define TUD_HID_REPORT_DESC_MOUSEHELP(...) \
|
|
|
|
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 ) ,\
|
2024-08-24 06:12:49 +08:00
|
|
|
/* X, Y position [-32767, 32767] */ \
|
2024-08-18 00:47:36 +08:00
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_X ) ,\
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_Y ) ,\
|
|
|
|
HID_LOGICAL_MIN_N ( 0x8000, 2 ) ,\
|
|
|
|
HID_LOGICAL_MAX_N ( 0x7fff, 2 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 16 ) ,\
|
|
|
|
HID_REPORT_COUNT( 2 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ) ,\
|
|
|
|
/* Vertical 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 ) ,\
|
2024-11-22 19:15:30 +08:00
|
|
|
/* Horizontal wheel (AC Pan) */ \
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_CONSUMER ) ,\
|
|
|
|
HID_LOGICAL_MIN ( 0x81 ) ,\
|
|
|
|
HID_LOGICAL_MAX ( 0x7f ) ,\
|
|
|
|
HID_REPORT_COUNT( 1 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
HID_USAGE_N ( HID_USAGE_CONSUMER_AC_PAN, 2 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ) ,\
|
|
|
|
\
|
2024-08-18 00:47:36 +08:00
|
|
|
/* Mouse mode (0 = absolute, 1 = relative) */ \
|
|
|
|
HID_REPORT_COUNT( 1 ), \
|
|
|
|
HID_REPORT_SIZE ( 8 ), \
|
|
|
|
HID_INPUT ( HID_CONSTANT ), \
|
|
|
|
HID_COLLECTION_END , \
|
|
|
|
HID_COLLECTION_END \
|
|
|
|
|
2024-08-24 06:12:49 +08:00
|
|
|
#define HID_USAGE_DIGITIZER 0x01
|
|
|
|
|
|
|
|
#define TUD_HID_REPORT_DESC_DIGITIZER_PEN(...) \
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DIGITIZER ) ,\
|
|
|
|
HID_USAGE ( HID_USAGE_DIGITIZER ) ,\
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
|
|
|
|
/* Report ID if any */\
|
|
|
|
__VA_ARGS__ \
|
|
|
|
HID_USAGE ( HID_USAGE_DIGITIZER ) ,\
|
|
|
|
HID_COLLECTION ( HID_COLLECTION_PHYSICAL ) ,\
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DIGITIZER ) ,\
|
|
|
|
/* Tip Pressure */\
|
|
|
|
HID_USAGE ( 0x30 ) ,\
|
|
|
|
HID_LOGICAL_MIN ( 0x00 ) ,\
|
|
|
|
HID_LOGICAL_MAX ( 0xff ) ,\
|
|
|
|
HID_REPORT_COUNT( 1 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 8 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
|
|
|
|
\
|
|
|
|
HID_REPORT_COUNT( 5 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 1 ) ,\
|
|
|
|
/* In range */\
|
|
|
|
HID_USAGE ( 0x32 ) ,\
|
|
|
|
/* Tip switch */\
|
|
|
|
HID_USAGE ( 0x42 ) ,\
|
|
|
|
/* Eraser */\
|
|
|
|
HID_USAGE ( 0x45 ) ,\
|
|
|
|
/* Barrel switch */\
|
|
|
|
HID_USAGE ( 0x44 ) ,\
|
|
|
|
/* Invert */\
|
|
|
|
HID_USAGE ( 0x3c ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
|
|
|
|
\
|
|
|
|
HID_REPORT_COUNT( 3 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 1 ) ,\
|
|
|
|
HID_INPUT ( HID_CONSTANT ) ,\
|
|
|
|
/* X and Y coordinates */\
|
|
|
|
HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_X ) ,\
|
|
|
|
HID_USAGE ( HID_USAGE_DESKTOP_Y ) ,\
|
|
|
|
HID_LOGICAL_MIN ( 0 ) ,\
|
|
|
|
HID_LOGICAL_MAX_N ( 32767, 2 ) ,\
|
|
|
|
HID_REPORT_SIZE ( 16 ) ,\
|
|
|
|
HID_REPORT_COUNT ( 2 ) ,\
|
|
|
|
HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE) ,\
|
|
|
|
HID_COLLECTION_END ,\
|
|
|
|
HID_COLLECTION_END
|
|
|
|
|
2023-12-25 06:22:05 +08:00
|
|
|
#endif /* USB_DESCRIPTORS_H_ */
|